Skip to content

Commit c023727

Browse files
authored
Update README.md (#40)
Update README to include extra intro text and install info.
1 parent 0ba22f1 commit c023727

File tree

1 file changed

+43
-19
lines changed

1 file changed

+43
-19
lines changed

README.md

+43-19
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,58 @@
1-
# Machine Learning in .NET
21

3-
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.
42

5-
### Build Status
3+
# Machine Learning for .NET
64

7-
Coming soon
5+
[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.
86

9-
### Installation
7+
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, all in .NET.
108

11-
You can install ML.NET NuGet from the CLI using:
9+
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, PowerPoint, Excel and more.
10+
11+
With this first preview release ML.NET enables ML tasks like classification (e.g. support text classification, sentiment analysis) and regression (e.g. price-prediction).
12+
13+
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 ML data structures.
14+
15+
## Installation
16+
17+
ML.NET runs on Windows, Linux, and macOS - any platform where 64 bit [.NET Core](https://github.com/dotnet/core) or later is available.
18+
19+
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).
20+
21+
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.
22+
23+
Once you have an app, you can install ML.NET NuGet from the .NET Core CLI using:
1224
```
1325
dotnet add package Microsoft.ML
1426
```
1527

16-
From package manager:
28+
or from the package manager:
1729
```
1830
Install-Package Microsoft.ML
1931
```
20-
For an example of getting started with .NET Core, see [here](https://www.microsoft.com/net/learn/get-started).
2132

22-
### Building
23-
To build ML.NET from source go to [developers guide](https://github.com/dotnet/machinelearning/blob/master/Documentation/project-docs/developer-guide.md)
33+
Or alternatively you can add the Microsoft.ML package from within Visual Studio's NuGet package manager.
34+
35+
## Building
36+
37+
To build ML.NET from source please visit our [developers guide](Documentation/project-docs/developer-guide.md).
38+
39+
Live build status is coming soon.
40+
41+
## Contributing
42+
43+
We welcome contributions! Please review our [contribution guide](CONTRIBUTING.md).
2444

25-
### Example
45+
## Community
46+
47+
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)
48+
49+
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community.
50+
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
51+
52+
## Examples
53+
54+
Here's an example of 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)):
2655

27-
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)):
2856
```C#
2957
var pipeline = new LearningPipeline();
3058
pipeline.Add(new TextLoader<SentimentData>(dataPath, separator: ","));
@@ -33,7 +61,7 @@ pipeline.Add(new FastTreeBinaryClassifier());
3361
var model = pipeline.Train<SentimentData, SentimentPrediction>();
3462
```
3563

36-
Infer the trained model for predictions:
64+
Now from the model we can make inferences (predictions):
3765

3866
```C#
3967
SentimentData data = new SentimentData
@@ -46,11 +74,6 @@ SentimentPrediction prediction = model.Predict(data);
4674
Console.WriteLine("prediction: " + prediction.Sentiment);
4775
```
4876

49-
### Code of Conduct
50-
51-
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community.
52-
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
53-
5477
## License
5578

5679
ML.NET is licensed under the [MIT license](LICENSE).
@@ -61,4 +84,5 @@ ML.NET is a [.NET Foundation](http://www.dotnetfoundation.org/projects) project.
6184

6285
There are many .NET related projects on GitHub.
6386

64-
- [.NET home repo](https://github.com/Microsoft/dotnet) - links to 100s of .NET projects, from Microsoft and the community.
87+
- [.NET home repo](https://github.com/Microsoft/dotnet) - links to 100s of .NET projects, from Microsoft and the community.
88+

0 commit comments

Comments
 (0)