Skip to content

Refresh ML.NET documentation and native dependency setup - #7760

Open
svick wants to merge 9 commits into
mainfrom
docs/cleanup-readmes
Open

svick wants to merge 9 commits into
mainfrom
docs/cleanup-readmes

Conversation

@svick

@svick svick commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Summary

  • remove the obsolete Korean and oneDAL READMEs while preserving maintained oneDAL guidance
  • remove outdated community links, package-installation commands, pipeline badges, build guidance, and Static API references
  • refresh TensorFlow, platform-support, contribution, release, and developer documentation
  • add an ML.NET-owned native dependency installer that includes OpenMP setup and use it consistently in CI and contributor guidance
  • rename the cookbook sample test class after removing the obsolete Dynamic API distinction

Historical release notes and ROADMAP.md were intentionally left unchanged.

Validation

  • validated the dependency installer with Podman on Ubuntu, Debian, Fedora, Amazon Linux, Alpine, Azure Linux, CentOS, and RHEL; automatic installation succeeds on the documented supported distributions, while the manual-install warning is emitted for the others
  • validated the macOS installer branch with mocked commands because macOS containers are unavailable
  • built the repository in Debug configuration
  • ran all 15 CookbookSamples tests on net8.0

svick and others added 3 commits October 2, 2026 13:22
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Update build, platform, dependency, and contribution guidance; remove obsolete Static API references; and rename the cookbook sample test class.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Build prerequisites, command paths, and platform configuration guidance need corrections so contributors can follow the refreshed documentation successfully.

Review effort: Balanced
Findings: 6 Low severity

Open (6)
What changed in this PR

Refreshes ML.NET’s user and contributor documentation while preserving historical release notes and ROADMAP.md.

Changes:

  • Removes obsolete READMEs and Static API references.
  • Updates build, platform, TensorFlow, contribution, and release guidance.
  • Preserves oneDAL guidance and renames the cookbook sample test class.
File Description
test/​Microsoft.ML.Tests/​Scenarios/​Api/​CookbookSamples/​CookbookSamples.cs Renames the class and cleans up comments.
README.md Refreshes installation, platform, and CI information.
README.ko-KR.md Removes the obsolete localized README.
README-oneDAL.md Removes the standalone oneDAL README.
docs/​README.md Updates macOS terminology.
docs/​project-docs/​release-process.md Updates terminology and installation command.
docs/​project-docs/​platform-limitations.md Revises architecture and native-component limitations.
docs/​project-docs/​developer-guide.md Refreshes build and test instructions.
docs/​project-docs/​contributing.md Updates contribution guidance link.
docs/​project-docs/​components-and-dependencies.md Preserves oneDAL activation guidance.
docs/​code/​MlNetCookBook.md Removes obsolete Static API references.
docs/​building/​windows-instructions.md Updates Windows build prerequisites.
docs/​building/​unix-instructions.md Replaces outdated dependency instructions.
docs/​api-reference/​tensorflow-usage.md Refreshes CPU and GPU runtime guidance.
CONTRIBUTING.md Updates contributor resources and headings.
.github/​copilot-instructions.md Clarifies SDK selection and CI roles.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/building/unix-instructions.md Outdated
Comment thread docs/building/unix-instructions.md Outdated
Comment thread docs/building/unix-instructions.md Outdated
Comment thread docs/project-docs/components-and-dependencies.md Outdated
Comment thread docs/project-docs/developer-guide.md Outdated
Comment thread docs/project-docs/platform-limitations.md Outdated
svick and others added 3 commits October 2, 2026 17:31
Split Windows x64 and x86 support and identify the 64-bit-only TensorFlow, LightGBM training, and TorchSharp functionality.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Correct Unix setup ordering and commands, document oneDAL startup requirements, and use cross-platform project paths.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@codecov

codecov Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.26%. Comparing base (cd77dea) to head (67c78a6).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7760      +/-   ##
==========================================
+ Coverage   70.25%   70.26%   +0.01%     
==========================================
  Files        1419     1419              
  Lines      272569   272569              
  Branches    27938    27938              
==========================================
+ Hits       191493   191529      +36     
+ Misses      73661    73632      -29     
+ Partials     7415     7408       -7     
Flag Coverage Δ
Debug 70.26% <100.00%> (+0.01%) ⬆️
production 64.52% <ø> (+0.01%) ⬆️
test 89.78% <100.00%> (ø)

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

Files with missing lines Coverage Δ
...s/Scenarios/Api/CookbookSamples/CookbookSamples.cs 95.89% <100.00%> (ø)

... and 8 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Add an ML.NET-owned wrapper that installs OpenMP on supported platforms, warns where manual setup is required, and use it across CI and contributor documentation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@svick svick changed the title Refresh ML.NET documentation Refresh ML.NET documentation and native dependency setup Oct 9, 2026
@svick
svick requested a balanced review from Copilot October 9, 2026 13:33

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Comment thread docs/api-reference/tensorflow-usage.md Outdated
Comment thread docs/code/MlNetCookBook.md
Clarified instructions for adding GPU package for TensorFlow.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@svick
svick requested a balanced review from Copilot October 9, 2026 13:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

Cross-platform installer behavior and support claims span environments that cannot be fully verified from the repository snapshot.

0 open findings

2 resolved since last review

🧠 Review effort: Balanced

@svick
svick marked this pull request as ready for review October 9, 2026 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants