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: Add Using MODEL parameters form lightwood into mindsdb docs. #2372

Closed
1 task done
ianu82 opened this issue Jun 22, 2022 · 1 comment · Fixed by #2436
Closed
1 task done

DOCS: Add Using MODEL parameters form lightwood into mindsdb docs. #2372

ianu82 opened this issue Jun 22, 2022 · 1 comment · Fixed by #2436
Assignees

Comments

@ianu82
Copy link
Collaborator

ianu82 commented Jun 22, 2022

Is there an existing issue for this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe.

It isn't clear from the current docs which models can be specified with the USING statement on this page.

This was raised by a customer.

The model section in the table tries to address this by linking to Lightwood here

Screenshot 2022-06-22 at 14 58 12

However, this is confusing in a couple of ways:

  1. The link is easy to miss.
  2. MindsDB calls them "models" in USING parameter_key but you land on a page detailing "Mixers". A user would wonder are they the same?
  3. The syntax/upper case/lower case is unclear from ones docs to the other (even if it is obvious why). Presumably it should be implemented as "LightGBM" in MindsDB not "mixer.LightGBM" for instance.
  4. What is Lightwood? Should I be using it instead?

Describe the solution you'd like.

It would probably make sense to have a section somewhere in the docs of everything that MindsDB supports rather than rely on Lightwood docs.

Describe an alternate solution.

No response

Anything else? (Additional Context)

No response

@Ricram2 Ricram2 self-assigned this Jun 22, 2022
@Ricram2 Ricram2 changed the title DOCS: Add available models to be selected with USING statement to MindsDB docs DOCS: Add Using MODEL parameters form lightwood into mindsdb docs. Jun 29, 2022
@Ricram2
Copy link
Member

Ricram2 commented Jul 4, 2022

  • The link is easy to miss.
  • MindsDB calls them "models" in USING parameter_key but you land on a page detailing "Mixers". A user would wonder are they the same? @paxcema (What do you think we should do here?)
  • The syntax/upper case/lower case is unclear from ones docs to the other (even if it is obvious why). Presumably it should be implemented as "LightGBM" in MindsDB not "mixer.LightGBM" for instance.
  • What is Lightwood? Should I be using it instead?

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 a pull request may close this issue.

2 participants