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

Clean up README examples #1709

Merged
merged 6 commits into from
Feb 6, 2025
Merged

Clean up README examples #1709

merged 6 commits into from
Feb 6, 2025

Conversation

yeonsily
Copy link
Collaborator

What does this PR do?

Clean up README examples for old models.

Fixes # (issue)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

@yeonsily yeonsily requested a review from libinta January 21, 2025 21:01
@yeonsily yeonsily requested a review from regisss as a code owner January 21, 2025 21:01
@yeonsily yeonsily requested a review from sywangyi January 21, 2025 21:36
@xhaihao
Copy link
Contributor

xhaihao commented Jan 22, 2025

@yeonsily could you please add the example for baichuan2 back ? Baichuan2 is still in use.

@mengker33
Copy link
Contributor

Hi @yeonsily , chatglm3-6b is recently added model and still in use, can you please keep it in README, thank you:)

@yeonsily
Copy link
Collaborator Author

@mengker33 @xhaihao Thanks for the review. If these models are still in use, can you please add them to CI test?

@xhaihao
Copy link
Contributor

xhaihao commented Jan 23, 2025

@yeonsily We have included Baichuan2 and chatglm3-6b in tests/test_text_generation_example.py. Could you please confirm if this is sufficient for the CI testing? Thank you very much!

@regisss
Copy link
Collaborator

regisss commented Jan 23, 2025

@xhaihao @mengker33 I believe the goal of this PR is to simplify the READMEs as they contain many very similar commands. I think having concise READMEs is defintely a good thing, otherwise people will just not look at them.
Fine-tuning Baichuan and ChatGLM with DeepSpeed should still be pretty straightforward given that a few example commands are still given, unless there are specific arguments to use for these two models?

@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.

@libinta libinta added the run-test Run CI for PRs from external contributors label Feb 6, 2025
Copy link
Collaborator

@regisss regisss left a comment

Choose a reason for hiding this comment

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

LGTM!

@regisss regisss merged commit 27d1495 into main Feb 6, 2025
7 checks passed
@regisss regisss deleted the clean_readme branch February 6, 2025 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
run-test Run CI for PRs from external contributors
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants