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] DataLoaderConfiguration docstring #3103

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

stevhliu
Copy link
Member

Fixes #3100 by adding docstring to the DataLoaderConfiguration class.

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Collaborator

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

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

Thanks!

@muellerzr muellerzr merged commit b32d8bc into huggingface:main Sep 11, 2024
25 checks passed
@stevhliu stevhliu deleted the docstrings branch September 11, 2024 17:28
@brynhayder
Copy link

brynhayder commented Sep 12, 2024

IIRC the fields docs were not autogenerated for other classes too, would there be a way to simply change the settings on your documentation generation to pick that up?

e.g.

class ProjectConfiguration:

docs for fields not generated on main. similarly for BnB config class.

@muellerzr
Copy link
Collaborator

muellerzr commented Sep 12, 2024

At this time our docparser doesn't do this 😿

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.

Documentation for dataclass fields not fully generated
4 participants