Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added more up-to-date ONNX docs #1781

Merged
merged 7 commits into from Jan 11, 2023
Merged

Conversation

svotaw
Copy link
Collaborator

@svotaw svotaw commented Jan 3, 2023

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Added docs for new ONNX content.

How is this patch tested?

  • I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.

Does this PR change any dependencies?

  • No. You can skip this section.
  • Yes. Make sure the dependencies are resolved correctly, and list changes here.

Does this PR add a new feature? If so, have you added samples on website?

  • No. You can skip this section.
  • Yes. Make sure you have added samples following below steps.
  1. Find the corresponding markdown file for your new feature in website/docs/documentation folder.
    Make sure you choose the correct class estimators/transformers and namespace.
  2. Follow the pattern in markdown file and add another section for your new API, including pyspark, scala (and .NET potentially) samples.
  3. Make sure the DocTable points to correct API link.
  4. Navigate to website folder, and run yarn run start to make sure the website renders correctly.
  5. Don't forget to add <!--pytest-codeblocks:cont--> before each python code blocks to enable auto-tests for python samples.
  6. Make sure the WebsiteSamplesTests job pass in the pipeline.

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Word and
Phrases Score
Correctness
Score
Scorecard Processed
website/docs/features/onnx/about.md 76 100 66 link

More information about Acrolinx

@github-actions
Copy link

github-actions bot commented Jan 3, 2023

Hey @svotaw 👋!
Thank you so much for contributing to our repository 🙌.
Someone from SynapseML Team will be reviewing this pull request soon.

We use semantic commit messages to streamline the release process.
Before your pull request can be merged, you should make sure your first commit and PR title start with a semantic prefix.
This helps us to create release messages and credit you for your hard work!

Examples of commit messages with semantic prefixes:

  • fix: Fix LightGBM crashes with empty partitions
  • feat: Make HTTP on Spark back-offs configurable
  • docs: Update Spark Serving usage
  • build: Add codecov support
  • perf: improve LightGBM memory usage
  • refactor: make python code generation rely on classes
  • style: Remove nulls from CNTKModel
  • test: Add test coverage for CNTKModel

To test your commit locally, please follow our guild on building from source.
Check out the developer guide for additional guidance on testing your change.

@svotaw
Copy link
Collaborator Author

svotaw commented Jan 4, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@codecov-commenter
Copy link

codecov-commenter commented Jan 4, 2023

Codecov Report

Merging #1781 (709ee25) into master (dd1563f) will decrease coverage by 9.32%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1781      +/-   ##
==========================================
- Coverage   86.08%   76.75%   -9.33%     
==========================================
  Files         278      278              
  Lines       14722    14722              
  Branches      767      767              
==========================================
- Hits        12673    11300    -1373     
- Misses       2049     3422    +1373     
Impacted Files Coverage Δ
...m/src/main/scala/com/microsoft/lightgbm/SWIG.scala 0.00% <0.00%> (-100.00%) ⬇️
...pse/ml/lightgbm/params/ClassifierTrainParams.scala 0.00% <0.00%> (-100.00%) ⬇️
...e/synapse/ml/lightgbm/StreamingPartitionTask.scala 0.00% <0.00%> (-97.11%) ⬇️
...zure/synapse/ml/lightgbm/dataset/SampledData.scala 0.00% <0.00%> (-90.00%) ⬇️
...ure/synapse/ml/cognitive/speech/AudioStreams.scala 0.00% <0.00%> (-87.88%) ⬇️
...azure/synapse/ml/lightgbm/LightGBMClassifier.scala 10.75% <0.00%> (-80.65%) ⬇️
...apse/ml/cognitive/form/FormRecognizerSchemas.scala 7.69% <0.00%> (-76.93%) ⬇️
...ynapse/ml/cognitive/form/FormOntologyLearner.scala 14.28% <0.00%> (-75.52%) ⬇️
...azure/synapse/ml/featurize/text/PageSplitter.scala 25.58% <0.00%> (-74.42%) ⬇️
.../synapse/ml/cognitive/speech/SpeechToTextSDK.scala 18.03% <0.00%> (-73.34%) ⬇️
... and 43 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Collaborator

@mhamilton723 mhamilton723 left a comment

Choose a reason for hiding this comment

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

Love it! Just a few minor comments and nits

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Word and
Phrases Score
Correctness
Score
Scorecard Processed
website/docs/features/onnx/about.md 87 100 73 link

More information about Acrolinx

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Word and
Phrases Score
Correctness
Score
Scorecard Processed
website/docs/features/onnx/about.md 87 100 73 link

More information about Acrolinx

@svotaw
Copy link
Collaborator Author

svotaw commented Jan 5, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link
Collaborator

@mhamilton723 mhamilton723 left a comment

Choose a reason for hiding this comment

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

It still looks like theres a few good suggestions in acrolinx

https://microsoft-ce-csi.acrolinx.cloud/api/v1/checking/scorecards/b36dc9cd-07a6-4e59-a45e-1b79f16f682f

Would you be able do the easy ones (The nouns after this, contractions, a/an, and no e.g) ? (No need to correct Netron)

Wuld

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Word and
Phrases Score
Correctness
Score
Scorecard Processed
website/docs/features/onnx/about.md 96 100 80 link

More information about Acrolinx

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Word and
Phrases Score
Correctness
Score
Scorecard Processed
website/docs/features/onnx/about.md 96 100 80 link

More information about Acrolinx

@svotaw
Copy link
Collaborator Author

svotaw commented Jan 9, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@svotaw
Copy link
Collaborator Author

svotaw commented Jan 10, 2023

/azp run

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Word and
Phrases Score
Correctness
Score
Scorecard Processed
website/docs/features/onnx/about.md 96 100 80 link

More information about Acrolinx

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@acrolinxatmsft1
Copy link

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Word and
Phrases Score
Correctness
Score
Scorecard Processed
website/docs/features/onnx/about.md 96 100 80 link

More information about Acrolinx

@mhamilton723 mhamilton723 merged commit 974e36a into microsoft:master Jan 11, 2023
@svotaw svotaw deleted the onnxdocs branch January 12, 2023 16: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.

None yet

4 participants