dotnet / machinelearning

ML.NET is an open source and cross-platform machine learning framework for .NET.
https://dot.net/ml
MIT License
9.05k stars 1.88k forks source link

Add package readmes #7200

Closed michaelgsharp closed 4 months ago

michaelgsharp commented 4 months ago

Update to use preview 5 for building. Fixed some minor formatting issues that came from the preview 5 update. Added package readmes to 5 more packages for now, #7195

michaelgsharp commented 4 months ago

This will also fix all the blockers for #7165 except the async test one. I'll get a pr up for that one.

michaelgsharp commented 4 months ago

Actually it was such a minor change I just added it to this PR as well.

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 57.89474% with 16 lines in your changes missing coverage. Please review.

Project coverage is 68.81%. Comparing base (579fe03) to head (da80492). Report is 6 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #7200 +/- ## ========================================== - Coverage 69.06% 68.81% -0.26% ========================================== Files 1401 1267 -134 Lines 268516 259675 -8841 Branches 27812 26933 -879 ========================================== - Hits 185451 178689 -6762 + Misses 75902 74103 -1799 + Partials 7163 6883 -280 ``` | [Flag](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet) | Coverage Δ | | |---|---|---| | [Debug](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet) | `68.81% <57.89%> (-0.26%)` | :arrow_down: | | [production](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet) | `63.07% <57.89%> (-0.58%)` | :arrow_down: | | [test](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet) | `88.97% <ø> (+0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet) | Coverage Δ | | |---|---|---| | [src/Common/tests/RetryHelper.cs](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200?src=pr&el=tree&filepath=src%2FCommon%2Ftests%2FRetryHelper.cs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet#diff-c3JjL0NvbW1vbi90ZXN0cy9SZXRyeUhlbHBlci5jcw==) | `18.96% <ø> (ø)` | | | [...icrosoft.ML.Ensemble/EntryPoints/CreateEnsemble.cs](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200?src=pr&el=tree&filepath=src%2FMicrosoft.ML.Ensemble%2FEntryPoints%2FCreateEnsemble.cs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet#diff-c3JjL01pY3Jvc29mdC5NTC5FbnNlbWJsZS9FbnRyeVBvaW50cy9DcmVhdGVFbnNlbWJsZS5jcw==) | `83.49% <100.00%> (ø)` | | | [...icrosoft.ML.Tokenizers/Utils/ValueStringBuilder.cs](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200?src=pr&el=tree&filepath=src%2FMicrosoft.ML.Tokenizers%2FUtils%2FValueStringBuilder.cs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet#diff-c3JjL01pY3Jvc29mdC5NTC5Ub2tlbml6ZXJzL1V0aWxzL1ZhbHVlU3RyaW5nQnVpbGRlci5jcw==) | `47.01% <ø> (ø)` | | | [.../Microsoft.ML.Vision/ImageClassificationTrainer.cs](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200?src=pr&el=tree&filepath=src%2FMicrosoft.ML.Vision%2FImageClassificationTrainer.cs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet#diff-c3JjL01pY3Jvc29mdC5NTC5WaXNpb24vSW1hZ2VDbGFzc2lmaWNhdGlvblRyYWluZXIuY3M=) | `92.13% <100.00%> (ø)` | | | [...osoft.Data.Analysis.Tests/ArrowIntegrationTests.cs](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200?src=pr&el=tree&filepath=test%2FMicrosoft.Data.Analysis.Tests%2FArrowIntegrationTests.cs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet#diff-dGVzdC9NaWNyb3NvZnQuRGF0YS5BbmFseXNpcy5UZXN0cy9BcnJvd0ludGVncmF0aW9uVGVzdHMuY3M=) | `100.00% <ø> (ø)` | | | [...rc/Microsoft.ML.FastTree/Utils/StreamExtensions.cs](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200?src=pr&el=tree&filepath=src%2FMicrosoft.ML.FastTree%2FUtils%2FStreamExtensions.cs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet#diff-c3JjL01pY3Jvc29mdC5NTC5GYXN0VHJlZS9VdGlscy9TdHJlYW1FeHRlbnNpb25zLmNz) | `0.00% <0.00%> (ø)` | | | [src/Microsoft.ML.Data/Utilities/StreamUtils.cs](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200?src=pr&el=tree&filepath=src%2FMicrosoft.ML.Data%2FUtilities%2FStreamUtils.cs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet#diff-c3JjL01pY3Jvc29mdC5NTC5EYXRhL1V0aWxpdGllcy9TdHJlYW1VdGlscy5jcw==) | `64.33% <55.88%> (-2.64%)` | :arrow_down: | ... and [144 files with indirect coverage changes](https://app.codecov.io/gh/dotnet/machinelearning/pull/7200/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dotnet)