-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md #40
Update README.md #40
Changes from 7 commits
1e2456a
0d9a418
47972c1
82b0610
5328592
8ee9bdd
e9460eb
aca4e45
83f8d77
0c4b35b
2338344
1693e4d
e8b3732
b631ffb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,62 @@ | ||
# Machine Learning in .NET | ||
|
||
ML.NET provides state-of-the-art machine learning (ML) algorithms, transforms, and components, and powers ML pipelines in many Microsoft products. Developed and used internally at Microsoft for over 5 years, the goal is to make ML.NET useful for all developers, data scientists, and information workers and helpful in all products, services, and devices. | ||
|
||
### Build Status | ||
# Machine Learning for .NET | ||
|
||
Coming soon | ||
[ML.NET](https://www.microsoft.com/net/learn/apps/machine-learning-and-ai/ml-dotnet) is a cross-platform open-source machine learning framework which makes machine learning accessible to .NET developers. | ||
|
||
### Installation | ||
ML.NET allows .NET developers to develop their own models and infuse custom ML into their applications without prior expertise in developing or tuning machine learning models. | ||
|
||
You can install ML.NET NuGet from the CLI using: | ||
ML.NET was originally developed in Microsoft Research and evolved into a significant framework over the last decade and is used across many product groups in Microsoft like Windows, Bing, Power Point, Excel and more. | ||
|
||
With this first preview release ML.NET enables ML tasks like classification (e.g. support text classification, sentiment analysis) and regression (e.g. forecasting, price-prediction). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Forecasting should be removed or replaced with some other term. |
||
|
||
Along with these ML capabilities this first release of ML.NET also brings the first draft of .NET APIs for training models, using models for predictions, as well as the core components of this framework such as learning algorithms, transforms, and core ML data structures. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would avoid using the trem "Core ML data structures", to avoid confusion with CoreML. |
||
|
||
ML.NET is first and foremost a framework which means it can be extended to add popular ML Libraries like TensorFlow, Accord.NET and CNTK. The design of the framework will prioritize usability, extensibility, and toolability, without sacrificing performance. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. extra space in "a framework" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This paragraph has to be completely rewritten. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I tweaked it slightly per your offline comments. Anything more, you should talk to Ankit as this is his text. |
||
|
||
## Installation | ||
|
||
ML.NET runs on Windows, Linux, and macOS - any platform where 64 bit [.NET Core](https://github.com/dotnet/core) or later is available. | ||
|
||
The current release is 0.1. Check out the [release notes](https://github.com/dotnet/machinelearning/blob/master/Documentation/release-notes/0.1/release-0.1.md). | ||
|
||
First ensure you have installed [.NET Core 2.0](https://www.microsoft.com/net/learn/get-started) or later. ML.NET also works on the .NET Framework. Note that ML.NET currently must run in a 64 bit process. | ||
|
||
Once you have an app, you can install ML.NET NuGet from the .NET Core CLI using: | ||
``` | ||
dotnet add package Microsoft.ML | ||
``` | ||
|
||
From package manager: | ||
or from the package manager: | ||
``` | ||
Install-Package Microsoft.ML | ||
``` | ||
For an example of getting started with .NET Core, see [here](https://www.microsoft.com/net/learn/get-started). | ||
|
||
### Building | ||
To build ML.NET from source go to [developers guide](https://github.com/dotnet/machinelearning/blob/master/Documentation/project-docs/developer-guide.md) | ||
Or alternatively you can add the Microsoft.ML package from within Visual Studio's NuGet package manager. | ||
|
||
## Building | ||
|
||
To build ML.NET from source please visit our [developers guide.](https://github.com/dotnet/machinelearning/blob/master/Documentation/project-docs/developer-guide.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should this be: developers guide. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you clarify? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. just a nit. dot does not need the hyperlink and the link also can be relative. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Dot vanishes if I move it There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Made link relative. |
||
|
||
Live build status is coming soon. | ||
|
||
## Contributing | ||
|
||
We welcome contributions! Please review our [contribution guide](https://github.com/dotnet/machinelearning/blob/master/CONTRIBUTING.md). | ||
|
||
### Example | ||
## Community | ||
|
||
Please join our community on Gitter [![Join the chat at https://gitter.im/dotnet/corefx](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dotnet/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
|
||
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community. | ||
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). | ||
|
||
## Examples | ||
|
||
Imagine you want to predict the sale price of a house. Given a large dataset of information about other houses, including their sale prices, you can use ML.NET to create and evaluate a model. Then, you can deploy the model with your app. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should we instead just have link to the samples folder? not sure if two different examples here is helpful. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The only purpose of examples in the readme are to illustrate why folks should use ML.NET. The samples are to teach/educate. Perhaps not quite the same? I'm happy to do it any way you guys think. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree, I think it may be more helpful to put the same paragraph but regarding Sentiment for which we have the code snippet rather than house price. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed |
||
|
||
Here's a different example, with code, to train a model to predict sentiment from text samples. (You can see the complete sample [here](https://github.com/dotnet/machinelearning/blob/master/test/Microsoft.ML.Tests/Scenarios/Scenario3_SentimentPrediction.cs)): | ||
|
||
Simple snippet to train a model for sentiment classification (See the complete sample [here](https://github.com/dotnet/machinelearning/blob/master/test/Microsoft.ML.Tests/Scenarios/Scenario3_SentimentPrediction.cs)): | ||
```C# | ||
var pipeline = new LearningPipeline(); | ||
pipeline.Add(new TextLoader<SentimentData>(dataPath, separator: ",")); | ||
|
@@ -33,7 +65,7 @@ pipeline.Add(new FastTreeBinaryClassifier()); | |
var model = pipeline.Train<SentimentData, SentimentPrediction>(); | ||
``` | ||
|
||
Infer the trained model for predictions: | ||
Now from the model we can make inferences (predictions): | ||
|
||
```C# | ||
SentimentData data = new SentimentData | ||
|
@@ -46,11 +78,6 @@ SentimentPrediction prediction = model.Predict(data); | |
Console.WriteLine("prediction: " + prediction.Sentiment); | ||
``` | ||
|
||
### Code of Conduct | ||
|
||
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community. | ||
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). | ||
|
||
## License | ||
|
||
ML.NET is licensed under the [MIT license](LICENSE). | ||
|
@@ -61,4 +88,5 @@ ML.NET is a [.NET Foundation](http://www.dotnetfoundation.org/projects) project. | |
|
||
There are many .NET related projects on GitHub. | ||
|
||
- [.NET home repo](https://github.com/Microsoft/dotnet) - links to 100s of .NET projects, from Microsoft and the community. | ||
- [.NET home repo](https://github.com/Microsoft/dotnet) - links to 100s of .NET projects, from Microsoft and the community. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PowerPoint no space