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

fix: Add docs for passThroughArgs #1749

Merged
merged 4 commits into from
Dec 1, 2022

Conversation

svotaw
Copy link
Collaborator

@svotaw svotaw commented Nov 30, 2022

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Add some docs to explain how LightGBM passThroughArgs works

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.

@svotaw svotaw requested a review from JessicaXYWang November 30, 2022 18:58
@github-actions
Copy link

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.

@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/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.0/features/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.1/features/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.2/features/lightgbm/about.md link ⚠️

More information about Acrolinx

@svotaw svotaw changed the title Add docs for passThroughArgs fix: Add docs for passThroughArgs Nov 30, 2022
@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/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.0/features/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.1/features/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.2/features/lightgbm/about.md link ⚠️

More information about Acrolinx

@svotaw
Copy link
Collaborator Author

svotaw commented Nov 30, 2022

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@codecov-commenter
Copy link

codecov-commenter commented Nov 30, 2022

Codecov Report

Merging #1749 (cd1d405) into master (b6ef511) will decrease coverage by 0.09%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1749      +/-   ##
==========================================
- Coverage   86.02%   85.92%   -0.10%     
==========================================
  Files         271      271              
  Lines       14126    14126              
  Branches      737      737              
==========================================
- Hits        12152    12138      -14     
- Misses       1974     1988      +14     
Impacted Files Coverage Δ
...re/synapse/ml/lightgbm/params/LightGBMParams.scala 100.00% <100.00%> (ø)
...rosoft/azure/synapse/ml/param/DataFrameParam.scala 67.64% <0.00%> (-11.77%) ⬇️
.../azure/synapse/ml/param/PythonWrappableParam.scala 69.23% <0.00%> (-7.70%) ⬇️
...ft/azure/synapse/ml/param/JsonEncodableParam.scala 57.33% <0.00%> (-5.34%) ⬇️
...oft/azure/synapse/ml/lightgbm/NetworkManager.scala 89.44% <0.00%> (-2.78%) ⬇️

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

@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/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.0/features/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.1/features/lightgbm/about.md link ⚠️
website/versioned_docs/version-0.10.2/features/lightgbm/about.md link ⚠️

More information about Acrolinx

@svotaw
Copy link
Collaborator Author

svotaw commented Nov 30, 2022

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@svotaw svotaw requested a review from JessicaXYWang November 30, 2022 21:32
@svotaw svotaw enabled auto-merge (squash) December 1, 2022 06:53
@mhamilton723 mhamilton723 disabled auto-merge December 1, 2022 12:45
@mhamilton723 mhamilton723 merged commit c6cc0a8 into microsoft:master Dec 1, 2022
serena-ruan pushed a commit to serena-ruan/SynapseML that referenced this pull request Dec 1, 2022
* Add docs for passThroughArgs

* doc edits
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.

5 participants