Update Linear and Logistic Regression Parameters & Improve Documentation #8982
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add comprehensive documentation for supported: - Optimizers (SIMPLE_SGD, LINEAR_DECAY_SGD, etc.) - Objective types (ABSOLUTE_LOSS, HUBER, SQUARED_LOSS) - Momentum types (STANDARD, NESTEROV) - Fix parameter name typos Signed-off-by: rithin-pullela-aws <[email protected]>
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
|
Corresponding code/ parameter names: https://github.com/opensearch-project/ml-commons/tree/main/common/src/main/java/org/opensearch/ml/common/input/parameter/regression |
rithin-pullela-aws
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
kolchfa-aws
reviewed
Dec 31, 2024
There was a problem hiding this comment.
Thank you, @rithin-pullela-aws! Could we add some more information for the user about these options?
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>
…momentum type. Signed-off-by: rithin-pullela-aws <[email protected]>
kolchfa-aws
approved these changes
Jan 8, 2025
natebower
requested changes
Jan 9, 2025
There was a problem hiding this comment.
@kolchfa-aws Please see my comments and changes and tag me for approval when complete. Thanks!
_ml-commons-plugin/algorithms.md
Outdated
| `optimiser` | String | The optimizer used in the model. | `SIMPLE_SGD` | ||
| `objective` | String | The Objective function used. | `SQUARED_LOSS` | ||
| `epochs` | Integer | The number of iterations. | `5`| | ||
| `batch_size` | Integer | The size of min batches. | `1` |
There was a problem hiding this comment.
"The minimum batch size"?
_ml-commons-plugin/algorithms.md
Outdated
| | `momentumType` | String | The Stochastic Gradient Descent (SGD) momentum that helps accelerate gradient vectors in the right direction, leading to faster convergence between vectors. | `STANDARD` | | ||
| | `optimizerType` | String | The optimizer used in the model. | `AdaGrad` | | ||
| | `decay_rate` | Double | The Root Mean Squared Propagation (RMSProp). | `0.9` | | ||
| | `momentum_type` | String | The Stochastic Gradient Descent (SGD) momentum that helps accelerate gradient vectors in the correct direction, leading to faster convergence between vectors. | `STANDARD` | |
There was a problem hiding this comment.
On line 79, "correct direction, leading to faster convergence between vectors" is "right directions, leading to a fast convergence". Please make consistent.
_ml-commons-plugin/algorithms.md
Outdated
| | `epochs` | Integer | The number of iterations. | `5` | | ||
| | `batchSize` | Integer | The size of min batches. | `1` | | ||
| | `loggingInterval` | Integer | The interval of logs lost after many iterations. The interval is `1` if the algorithm contains no logs. | `1000` | | ||
| | `batch_size` | Integer | The size of min batches. | `1` | |
There was a problem hiding this comment.
"The minimum batch size"?
kolchfa-aws
reviewed
Jan 9, 2025
kolchfa-aws
reviewed
Jan 9, 2025
kolchfa-aws
reviewed
Jan 9, 2025
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
|
@natebower Comments addressed, thanks! |
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jan 9, 2025
…ion (#8982) * Update Linear and Logistic Regression Parameters & Improve Documentation - Add comprehensive documentation for supported: - Optimizers (SIMPLE_SGD, LINEAR_DECAY_SGD, etc.) - Objective types (ABSOLUTE_LOSS, HUBER, SQUARED_LOSS) - Momentum types (STANDARD, NESTEROV) - Fix parameter name typos Signed-off-by: rithin-pullela-aws <[email protected]> * Update _ml-commons-plugin/algorithms.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> * Added Tribuo documentation links to optimizers, Objective types, and momentum type. Signed-off-by: rithin-pullela-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: rithin-pullela-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit ff2f71b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
russcam
pushed a commit
to russcam/documentation-website
that referenced
this pull request
Jan 10, 2025
…ion (opensearch-project#8982) * Update Linear and Logistic Regression Parameters & Improve Documentation - Add comprehensive documentation for supported: - Optimizers (SIMPLE_SGD, LINEAR_DECAY_SGD, etc.) - Objective types (ABSOLUTE_LOSS, HUBER, SQUARED_LOSS) - Momentum types (STANDARD, NESTEROV) - Fix parameter name typos Signed-off-by: rithin-pullela-aws <[email protected]> * Update _ml-commons-plugin/algorithms.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> * Added Tribuo documentation links to optimizers, Objective types, and momentum type. Signed-off-by: rithin-pullela-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: rithin-pullela-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
russcam
pushed a commit
to russcam/documentation-website
that referenced
this pull request
Jan 12, 2025
…ion (opensearch-project#8982) * Update Linear and Logistic Regression Parameters & Improve Documentation - Add comprehensive documentation for supported: - Optimizers (SIMPLE_SGD, LINEAR_DECAY_SGD, etc.) - Objective types (ABSOLUTE_LOSS, HUBER, SQUARED_LOSS) - Momentum types (STANDARD, NESTEROV) - Fix parameter name typos Signed-off-by: rithin-pullela-aws <[email protected]> * Update _ml-commons-plugin/algorithms.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> * Added Tribuo documentation links to optimizers, Objective types, and momentum type. Signed-off-by: rithin-pullela-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: rithin-pullela-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Russ Cam <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Describe what this change achieves.
Issues Resolved
Closes #8981
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.