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: fix install instructions #2136

Merged
merged 4 commits into from
Nov 16, 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.

@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
docs/Get Started/Install SynapseML.md 79 100 60 link

More information about Acrolinx

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.

@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
docs/Get Started/Install SynapseML.md 77 100 60 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
docs/Get Started/Install SynapseML.md 77 100 60 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
docs/Get Started/Install SynapseML.md 77 100 60 link
website/versioned_docs/version-1.0.1/Explore Algorithms/AI Services/Advanced Usage - Async, Batching, and Multi-Key.md 79 100 44 link
website/versioned_docs/version-1.0.1/Explore Algorithms/AI Services/Overview.md 89 100 100 link
website/versioned_docs/version-1.0.1/Explore Algorithms/AI Services/Quickstart - Analyze Text.md 66 70 86 link
website/versioned_docs/version-1.0.1/Explore Algorithms/AI Services/Quickstart - Create a Visual Search Engine.md 83 100 100 link
website/versioned_docs/version-1.0.1/Explore Algorithms/AI Services/Quickstart - Document Question and Answering with PDFs.md 75 100 87 link
website/versioned_docs/version-1.0.1/Explore Algorithms/OpenAI/Langchain.md 74 100 67 link
website/versioned_docs/version-1.0.1/Explore Algorithms/OpenAI/Quickstart - Understand and Search Forms.md 73 100 83 link
website/versioned_docs/version-1.0.1/Explore Algorithms/Responsible AI/Explanation Dashboard.md 78 100 100 link
website/versioned_docs/version-1.0.1/Explore Algorithms/Responsible AI/Tabular Explainers.md 97 100 100 link
website/versioned_docs/version-1.0.1/Explore Algorithms/Responsible AI/Text Explainers.md 84 100 100 link
website/versioned_docs/version-1.0.1/Get Started/Install SynapseML.md 77 100 60 link
website/versioned_docs/version-1.0.1/Get Started/Quickstart - Your First Models.md 94 100 70 link
website/versioned_docs/version-1.0.1/Get Started/Set up Cognitive Services.md 84 100 100 link

More information about Acrolinx

@mhamilton723 mhamilton723 merged commit 9b20829 into microsoft:master Nov 16, 2023
6 checks passed
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

2 participants