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: Refactor docs and docgen framework #2021

Merged
merged 14 commits into from
Jul 19, 2023

Conversation

mhamilton723
Copy link
Collaborator

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Briefly describe the changes included in this Pull Request.

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.

@github-actions
Copy link

Hey @mhamilton723 👋!
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.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Summary by GPT-4

The code moves the files and directories to new locations. It renames the files and directories to match the new structure.

Suggestions

No suggestions are needed as the changes in this PR seem appropriate.

@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/Deploy Models/Overview.md 76 94 68 link
website/docs/Deploy Models/Quickstart - Deploying a Classifier.md 68 50 100 link
website/docs/Explore Algorithms/AI Services/Advanced Usage - Async, Batching, and Multi-Key.md 79 100 44 link
website/docs/Explore Algorithms/AI Services/Geospatial Services.md 72 57 73 link
website/docs/Explore Algorithms/AI Services/Multivariate Anomaly Detection.md 96 100 91 link
website/docs/Explore Algorithms/AI Services/Overview.md 91 100 95 link
website/docs/Explore Algorithms/AI Services/Quickstart - Analyze Celebrity Quotes.md 100 100 100 link
website/docs/Explore Algorithms/AI Services/Quickstart - Analyze Text.md 100 100 100 link
website/docs/Explore Algorithms/AI Services/Quickstart - Creare a Visual Search Engine.md 77 100 68 link
website/docs/Explore Algorithms/AI Services/Quickstart - Create Audiobooks.md 100 100 100 link
website/docs/Explore Algorithms/AI Services/Quickstart - Flooding Risk.md 77 74 100 link
website/docs/Explore Algorithms/AI Services/Quickstart - Predictive Maintenance.md 79 67 86 link
website/docs/Explore Algorithms/Anomaly Detection/Quickstart - Isolation Forests.md 72 100 83 link
website/docs/Explore Algorithms/Causal Inference/Overview.md 89 100 100 link
website/docs/Explore Algorithms/Causal Inference/Quickstart - Measure Causal Effects.md 86 100 74 link
website/docs/Explore Algorithms/Causal Inference/Quickstart - Measure Heterogeneous Effects.md 87 100 75 link
website/docs/Explore Algorithms/Classification/Quickstart - SparkML vs SynapseML.md 96 100 82 link
website/docs/Explore Algorithms/Classification/Quickstart - Train Classifier.md 92 100 100 link
website/docs/Explore Algorithms/Classification/Quickstart - Vowpal Wabbit on Tabular Data.md 82 100 100 link
website/docs/Explore Algorithms/Classification/Quickstart - Vowpal Wabbit on Text Data.md 73 72 100 link
website/docs/Explore Algorithms/Deep Learning/Distributed Training.md 97 100 100 link
website/docs/Explore Algorithms/Deep Learning/Getting Started.md 100 100 100 link
website/docs/Explore Algorithms/Deep Learning/ONNX.md 86 100 80 link
website/docs/Explore Algorithms/Deep Learning/Quickstart - Fine-Tune a Vision Classifier.md 100 100 100 link
website/docs/Explore Algorithms/Deep Learning/Quickstart - Fine-tune a Text Classifier.md 100 100 100 link
website/docs/Explore Algorithms/Deep Learning/Quickstart - ONNX Model Inference.md 100 100 100 link
website/docs/Explore Algorithms/Deep Learning/Quickstart - Transfer Learn for Image Classification.md 100 100 100 link
website/docs/Explore Algorithms/Hyperparameter Tuning/HyperOpt.md 77 100 90 link
website/docs/Explore Algorithms/Hyperparameter Tuning/Quickstart - Random Search.md 76 100 100 link
website/docs/Explore Algorithms/LightGBM/Overview.md 95 100 92 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/versioned_docs/version-0.10.0/about.md 100 100 100 link
website/versioned_docs/version-0.10.1/about.md 100 100 100 link
website/versioned_docs/version-0.10.2/about.md 100 100 100 link
website/versioned_docs/version-0.11.0/about.md 100 100 100 link
website/versioned_docs/version-0.11.1/about.md 100 100 100 link
website/versioned_docs/version-0.11.2/about.md 100 100 100 link
website/versioned_docs/version-0.9.4/about.md 100 100 100 link
website/versioned_docs/version-0.9.5/about.md 94 100 72 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/blog/overview.md 94 100 100 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/blog/overview.md 94 100 100 link

More information about Acrolinx

@mhamilton723
Copy link
Collaborator Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@codecov-commenter
Copy link

codecov-commenter commented Jul 19, 2023

Codecov Report

Merging #2021 (5994fe1) into master (ea60f56) will decrease coverage by 7.44%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master    #2021      +/-   ##
==========================================
- Coverage   87.06%   79.63%   -7.44%     
==========================================
  Files         306      306              
  Lines       16064    16068       +4     
  Branches      840      860      +20     
==========================================
- Hits        13986    12795    -1191     
- Misses       2078     3273    +1195     
Impacted Files Coverage Δ
...soft/azure/synapse/ml/core/env/FileUtilities.scala 71.05% <0.00%> (-8.36%) ⬇️

... and 58 files with indirect coverage changes

@mhamilton723
Copy link
Collaborator Author

/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/blog/overview.md 94 100 100 link

More information about Acrolinx

@azure-pipelines
Copy link

No commit pushedDate could be found for PR 2021 in repo microsoft/SynapseML

@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/blog/overview.md 94 100 100 link

More information about Acrolinx

@mhamilton723 mhamilton723 changed the title Refactor notebooks docs: Refactor docs and docgen framework Jul 19, 2023
@mhamilton723
Copy link
Collaborator Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@mhamilton723
Copy link
Collaborator Author

/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/blog/overview.md 94 100 100 link

More information about Acrolinx

@azure-pipelines
Copy link

No commit pushedDate could be found for PR 2021 in repo microsoft/SynapseML

@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/blog/overview.md 94 100 100 link

More information about Acrolinx

@mhamilton723
Copy link
Collaborator Author

/azp run

@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/blog/overview.md 94 100 100 link

More information about Acrolinx

@mhamilton723
Copy link
Collaborator Author

/azp run

@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/blog/overview.md 94 100 100 link

More information about Acrolinx

@mhamilton723
Copy link
Collaborator Author

/azp run

@azure-pipelines
Copy link

No commit pushedDate could be found for PR 2021 in repo microsoft/SynapseML

@mhamilton723
Copy link
Collaborator Author

/azp run

@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/blog/overview.md 94 100 100 link

More information about Acrolinx

@mhamilton723
Copy link
Collaborator Author

/azp run

@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/blog/overview.md 94 100 100 link

More information about Acrolinx

@mhamilton723
Copy link
Collaborator Author

/azp run

@azure-pipelines
Copy link

No commit pushedDate could be found for PR 2021 in repo microsoft/SynapseML

@mhamilton723
Copy link
Collaborator Author

/azp run

@azure-pipelines
Copy link

No commit pushedDate could be found for PR 2021 in repo microsoft/SynapseML

@mhamilton723
Copy link
Collaborator Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@mhamilton723 mhamilton723 merged commit 0926938 into microsoft:master Jul 19, 2023
66 of 67 checks passed
JessicaXYWang pushed a commit to JessicaXYWang/SynapseML that referenced this pull request Sep 14, 2023
* docs: Refactor docs and doc generation system

* remove old docusaurus versions

* fix broken links

* fix old references

* fix build issues

* small fix

* fix notebook upload

* standardize header

* remove boilerplate

* remove boilerplate

* update boilerplate

* update boilerplate

* fix docgen structure

* fixes
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

3 participants