Skip to content

Add package readmes#7200

Merged
michaelgsharp merged 8 commits intodotnet:mainfrom
michaelgsharp:nuget-readme
Jul 27, 2024
Merged

Add package readmes#7200
michaelgsharp merged 8 commits intodotnet:mainfrom
michaelgsharp:nuget-readme

Conversation

@michaelgsharp
Copy link
Copy Markdown
Contributor

@michaelgsharp michaelgsharp commented Jul 24, 2024

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
Copy link
Copy Markdown
Contributor Author

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

@michaelgsharp
Copy link
Copy Markdown
Contributor Author

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

## About

ML.NET is a cross-platform open-source machine learning framework which makes machine learning accessible to .NET developers.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually the read me list the major types and small specific sample in the package readme. Are we using the same readme template used in the runtime repo? .

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So it looks like FastTree is the only one that I missed for the major types. I'll get those in. As far as samples go, we have a link to the code samples repo. Do you think thats enough or do you think we should actually put some samples in here? I basically just copied what had been done for the main ML.NET package to these others ones.

Copy link
Copy Markdown
Member

@tarekgh tarekgh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left comment/question. LGTM otherwise.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jul 24, 2024

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
@@            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 Coverage Δ
Debug 68.81% <57.89%> (-0.26%) ⬇️
production 63.07% <57.89%> (-0.58%) ⬇️
test 88.97% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/Common/tests/RetryHelper.cs 18.96% <ø> (ø)
...icrosoft.ML.Ensemble/EntryPoints/CreateEnsemble.cs 83.49% <100.00%> (ø)
...icrosoft.ML.Tokenizers/Utils/ValueStringBuilder.cs 47.01% <ø> (ø)
.../Microsoft.ML.Vision/ImageClassificationTrainer.cs 92.13% <100.00%> (ø)
...osoft.Data.Analysis.Tests/ArrowIntegrationTests.cs 100.00% <ø> (ø)
...rc/Microsoft.ML.FastTree/Utils/StreamExtensions.cs 0.00% <0.00%> (ø)
src/Microsoft.ML.Data/Utilities/StreamUtils.cs 64.33% <55.88%> (-2.64%) ⬇️

... and 144 files with indirect coverage changes

Comment thread src/Microsoft.ML.OnnxTransformer/PACKAGE.md Outdated
@michaelgsharp michaelgsharp merged commit ba94d7a into dotnet:main Jul 27, 2024
@michaelgsharp michaelgsharp deleted the nuget-readme branch July 27, 2024 03:03
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants