|
| 1 | +# ML.NET AutoML |
| 2 | + |
| 3 | +[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. |
| 4 | + |
| 5 | +ML.NET allows .NET developers to develop their own models and infuse custom machine learning into their applications, using .NET, even without prior expertise in developing or tuning machine learning models. |
| 6 | + |
| 7 | +Automated machine learning (automated ML) builds high quality machine learning models for you by automating feature engineering, model, and hyperparameter selection. |
| 8 | +Bring a dataset that you want to build a model for, automated ML will give you a high quality machine learning model that you can use for predictions. |
| 9 | + |
| 10 | +If you are new to Data Science, AutoML will help you get jumpstarted by simplifying machine learning model building. |
| 11 | +It abstracts you from needing to perform feature engineering, model selection, hyperparameter selection and in one step creates a high quality trained model for you to use. |
| 12 | + |
| 13 | +If you are an experienced data scientist, AutoML will help increase your productivity by intelligently performing the feature engineering, model, and hyperparameter selection for your training and generates high quality models much more quickly than manually specifying several combinations of the parameters and running training jobs. |
| 14 | +AutoML provides visibility and access to all the training jobs and the performance characteristics of the models to help you further tune the pipeline if you desire. |
| 15 | + |
| 16 | +## Installation |
| 17 | + |
| 18 | +[](https://www.nuget.org/packages/Microsoft.ML.AutoML/) |
| 19 | + |
| 20 | +ML.NET runs on Windows, Linux, and macOS using [.NET Core](https://github.com/dotnet/core), or Windows using .NET Framework. 64 bit is supported on all platforms. 32 bit is supported on Windows, except for TensorFlow, LightGBM, and ONNX related functionality. |
| 21 | + |
| 22 | +First, ensure you have installed [.NET Core 2.1](https://www.microsoft.com/net/learn/get-started) or later. ML.NET also works on the .NET Framework 4.6.1 or later, but 4.7.2 or later is recommended. |
| 23 | + |
| 24 | +Once you have an app, you can install the ML.NET AutoML NuGet package from the .NET Core CLI using: |
| 25 | +``` |
| 26 | +dotnet add package Microsoft.ML.AutoML |
| 27 | +``` |
| 28 | + |
| 29 | +or from the NuGet package manager: |
| 30 | +``` |
| 31 | +Install-Package Microsoft.ML.AutoML |
| 32 | +``` |
| 33 | + |
| 34 | +Or alternatively, you can add the Microsoft.ML.AutoMO package from within Visual Studio's NuGet package manager or via [Paket](https://github.com/fsprojects/Paket). |
| 35 | + |
| 36 | +Daily NuGet builds of the project are also available in our [MyGet](https://dotnet.myget.org/feed/dotnet-core/package/nuget/Microsoft.ML.AutoML) feed: |
| 37 | + |
| 38 | +> [https://dotnet.myget.org/F/dotnet-core/api/v3/index.json](https://dotnet.myget.org/F/dotnet-core/api/v3/index.json) |
| 39 | +
|
| 40 | +## Building |
| 41 | + |
| 42 | +To build ML.NET AutoML from source please visit our [developers guide](docs/project-docs/developer-guide.md). |
| 43 | + |
| 44 | +| | Debug | Release | |
| 45 | +|:---|----------------:|------------------:| |
| 46 | +|**Linux**|[](https://dnceng.visualstudio.com/DotNet-Public/_build/latest?definitionId=312&branch=master)|[](https://dnceng.visualstudio.com/DotNet-Public/_build/latest?definitionId=312&branch=master)| |
| 47 | +|**macOS**|[](https://dnceng.visualstudio.com/DotNet-Public/_build/latest?definitionId=312&branch=master)|[](https://dnceng.visualstudio.com/DotNet-Public/_build/latest?definitionId=312&branch=master)| |
| 48 | +|**Windows x64**|[](https://dnceng.visualstudio.com/DotNet-Public/_build/latest?definitionId=312&branch=master)|[](https://dnceng.visualstudio.com/DotNet-Public/_build/latest?definitionId=312&branch=master)| |
| 49 | +|**Windows x86**|[](https://dnceng.visualstudio.com/public/_build/latest?definitionId=312?branchName=master)|[](https://dnceng.visualstudio.com/public/_build/latest?definitionId=312?branchName=master)| |
| 50 | +|**Core 3.0**|[](https://dnceng.visualstudio.com/public/_build/latest?definitionId=312?branchName=master)|[](https://dnceng.visualstudio.com/public/_build/latest?definitionId=312?branchName=master)| |
| 51 | + |
| 52 | +## Contributing |
| 53 | + |
| 54 | +We welcome contributions! Please review our [contribution guide](https://github.com/dotnet/machinelearning/blob/master/CONTRIBUTING.md). |
| 55 | + |
| 56 | +## Community |
| 57 | + |
| 58 | +Please join our community on Gitter [](https://gitter.im/dotnet/mlnet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 59 | + |
| 60 | +This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org/) to clarify expected behavior in our community. |
| 61 | +For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). |
| 62 | + |
| 63 | +## Examples |
| 64 | + |
| 65 | +Here's an example of code to automatically train a model to predict sentiment from text samples. |
| 66 | + |
| 67 | +```C# |
| 68 | +// Example to come |
| 69 | +
|
| 70 | +``` |
| 71 | + |
| 72 | +Now from the model we can make inferences (predictions): |
| 73 | + |
| 74 | +```C# |
| 75 | +var predictionEngine = model.CreatePredictionEngine<SentimentData, SentimentPrediction>(mlContext); |
| 76 | +var prediction = predictionEngine.Predict(new SentimentData |
| 77 | +{ |
| 78 | + SentimentText = "Today is a great day!" |
| 79 | +}); |
| 80 | +Console.WriteLine("prediction: " + prediction.Prediction); |
| 81 | +``` |
| 82 | +A cookbook that shows how to use these APIs for a variety of existing and new scenarios can be found [here](docs/code/MlNetCookBook.md). |
| 83 | + |
| 84 | + |
| 85 | +## Samples |
| 86 | + |
| 87 | +We have a [repo of samples](https://github.com/dotnet/machinelearning-samples) that you can look at. |
| 88 | + |
| 89 | +## License |
| 90 | + |
| 91 | +ML.NET is licensed under the [MIT license](LICENSE). |
| 92 | + |
| 93 | +## .NET Foundation |
| 94 | + |
| 95 | +ML.NET is a [.NET Foundation](https://www.dotnetfoundation.org/projects) project. |
| 96 | + |
| 97 | +There are many .NET related projects on GitHub. |
| 98 | + |
| 99 | +- [.NET home repo](https://github.com/Microsoft/dotnet) - links to 100s of .NET projects, from Microsoft and the community. |
0 commit comments