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

Add Doc Strings to Config Files #465

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

ParagEkbote
Copy link
Contributor

@ParagEkbote ParagEkbote commented Dec 19, 2024

As discussed in #247, I've added docstrings to the config class of the required files and updated some of them for enhanced clarity.

Please let me know if any further corrections are needed and I will make the necessary changes.

partially fixes #247

cc: @clefourrier

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added docstrings to the AdapterModel class as well to improve the clarity for the AdapterModelConfig class.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added the official documentation link for better reference.

@ParagEkbote ParagEkbote marked this pull request as ready for review December 20, 2024 10:18
@ParagEkbote ParagEkbote changed the title Add Documentation to Config Files Add Doc Strings to Config Files Dec 20, 2024
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.

[DOC] Document the custom model config files
1 participant