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

[DOC] Update Linear and Logistic Regression Parameters & Improve Documentation #8981

Open
1 of 4 tasks
rithin-pullela-aws opened this issue Dec 23, 2024 · 1 comment · May be fixed by #8982
Open
1 of 4 tasks

[DOC] Update Linear and Logistic Regression Parameters & Improve Documentation #8981

rithin-pullela-aws opened this issue Dec 23, 2024 · 1 comment · May be fixed by #8982
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. 2 - In progress Issue/PR: The issue or PR is in progress.

Comments

@rithin-pullela-aws
Copy link
Contributor

rithin-pullela-aws commented Dec 23, 2024

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request.
There is a need to update and improve the parameters used in the Linear and Logistic Regression implementations. Specifically, we need to:

  1. Add Comprehensive Documentation:
    Provide detailed documentation for the optimizers, objective types, and momentum types supported by the regression models.
  2. Fix Parameter Name Typos:
    There are several instances of inconsistent or incorrect parameter names. For example, learningRate should be correctly represented as learning_rate in the request body.
    Parameter typos: learning_rate, momentum_factor, decay_rate, momentum_type, and optimiser
  3. Add Descriptions for Other Available Parameters:
    Some parameters like objective, logging_interval, batch_size etc are not mentioned in the documentation.

Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
Find the documentation here.

@rithin-pullela-aws
Copy link
Contributor Author

Hi team, please assign this issue to me.

@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. 2 - In progress Issue/PR: The issue or PR is in progress. and removed untriaged labels Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. 2 - In progress Issue/PR: The issue or PR is in progress.
Projects
None yet
2 participants