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

adding readme for datasets #2491

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

August-murr
Copy link
Collaborator

What does this PR do?

Fixes #2470

well, that was just not worth it.

Dataset cards can only be added manually so this PR adds a function that modifies it's Readme file and pushes it and I honestly doubt it was worth the complication.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a GitHub issue? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines.
  • Did you write any new necessary tests?

Who can review?

@qgallouedec

@qgallouedec
Copy link
Member

qgallouedec commented Dec 17, 2024

Probably simpler:

from huggingface_hub import ModelCard

model_card = ModelCard("""
---
tags: [trl]
---

# Some title

""")

if script_args.push_to_hub:
    model_card.push_to_hub(script_args.repo_id, repo_type="dataset")

@August-murr
Copy link
Collaborator Author

Well, that's one way to overengineer it
I also opened issue on datasets to clarify.
I assume the next step is to add this to all the dataset scripts.

@qgallouedec
Copy link
Member

Very good like 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.

Provide Descriptions (READMEs) for trl-lib/dataset
2 participants