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

examples: Add details and improve descriptions #663

Closed
daavoo opened this issue Aug 15, 2023 · 0 comments
Closed

examples: Add details and improve descriptions #663

daavoo opened this issue Aug 15, 2023 · 0 comments
Labels
A: docs Area: user documentation enhancement p2-medium

Comments

@daavoo
Copy link
Contributor

daavoo commented Aug 15, 2023

          Thanks for making an example! 🙏Would like to propose some additions if you don´t mind. I can´t comment directly due to the notebook nature, so hopefully this can help. If you are time sensitive, and agree on the proposed additions/changes,  happy to submit a contrib.🎺
  1. Add # Goal/Intro section
    Cover the full functionality the example is exploring at the beginning of the notebook

Proposal : Example of fine-tuning sentiment analysis classifier based on imbd and distilbert pretrained model , experiment tracking and results metrics analysis with dvclive and dvc api

  1. Add section # Initialize git and dvc in 2nd cell
    why? It gives context about the necessary requirements beyond the libraries install that a data scientist needs to run some other HF examples

  2. Change # Dataset for # Dataset and Tokenization in 3rd cell
    The section includes a Tokenization process

  3. Add # Evaluation metrics section
    For consistency / coherence with respect to the process

  4. Possible discussion L28
    Describe in comment what log_model does for user? which seems to be the improvement of the PR?

  5. Explain # Comparing section
    Context : unclear right now whats really going on with naming . I´ve lost a few chapters of this exploring other things . Thinking about sharing in #9709 . When exploring this, a question came into my mind, what is the difference in between dvc.api and dvclive ?

Originally posted by @SoyGema in #649 (review)

@daavoo daavoo added A: docs Area: user documentation enhancement labels Aug 15, 2023
@SoyGema SoyGema mentioned this issue Sep 1, 2023
2 tasks
@dberenbaum dberenbaum closed this as not planned Won't fix, can't repro, duplicate, stale Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation enhancement p2-medium
Projects
None yet
Development

No branches or pull requests

2 participants