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 **kwargs param description for models #445

Closed
6 tasks done
ArtemLiA opened this issue Aug 3, 2024 · 2 comments · Fixed by #454
Closed
6 tasks done

[DOCS] Add **kwargs param description for models #445

ArtemLiA opened this issue Aug 3, 2024 · 2 comments · Fixed by #454
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ArtemLiA
Copy link

ArtemLiA commented Aug 3, 2024

📖 Documentation improvement

Hi! Looking through the documentation of some models, I noticed that some of them don't have a description of **kwargs parameters. I think we should fix it.

A list of models that don't have **kwargs argument description:

Additional context

No response

@ArtemLiA ArtemLiA added the documentation Improvements or additions to documentation label Aug 3, 2024
@d-a-bunin
Copy link
Collaborator

Usually, these kwargs mean that these additional parameters are added into the model constructor. It looks like a good idea to point this out in documentation.

And may be we should give a link to the place there user could see all the parameters. I don't think we should list all the possible parameters, because they could change in the future.

@ArtemLiA ArtemLiA changed the title [DOCS] Add **kwargs params description for models [DOCS] Add **kwargs param description for models Aug 6, 2024
@ArtemLiA
Copy link
Author

ArtemLiA commented Aug 6, 2024

Yes, I meant that we should add a mention that these parameters are added into model constructor and add link to the models. So, I am going to do it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants