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

[TRANSLATION] Add initial files and introduction to the course (main README.md) EN -> pt-BR translation #64

Merged
merged 7 commits into from
Dec 11, 2024

Conversation

ViniFBN
Copy link
Contributor

@ViniFBN ViniFBN commented Dec 8, 2024

December 2024 Student Submission

Module Completed

  • Module 1: Instruction Tuning
  • Module 2: Preference Alignment
  • Module 3: Parameter-efficient Fine-tuning
  • Module 4: Evaluation
  • Module 5: Vision-language Models
  • Module 6: Synthetic Datasets
  • Module 7: Inference
  • Module 8: Deployment

Changes Made

Describe what you've done in this PR:

  1. What concepts did you learn?
  2. What changes or additions did you make?
  3. Any challenges you faced?

Notebooks Added/Modified

List any notebooks you've added or modified:

  • Added new example in module_name/students/my_example.ipynb
  • Modified existing notebook with additional examples
  • Added documentation or comments

Checklist

  • I have read the module materials
  • My code runs without errors
  • I have pushed models and datasets to the huggingface hub
  • My PR is based on the december_2024 branch

Questions or Discussion Points

Add any questions you have or points you'd like to discuss:

  1. Following the pattern that the user @nsbg made, as it is the one available for now and easily adjustable, the translation is inside a folder called pt-br.
├── pt-br                  # Translated documents go here  
│   ├── 1_instruction_tuning          
│   ├── 2_preference_alignment
│   └── ...
├── 1_instruction_tuning   # Original directory       
└── 2_preference_alignment 

Additional Notes

As soon as we receive feedback, I will be translating the completed units (1 and 2). I also followed the example of the label, attaching a [TRANSLATION] for easier recognition. If it is to be changed, I will be following it accordingly.

Creating a placeholder folder for now
Initial translation of the documentation, to give a nice introduction to what the course is about
Fixed a typo
@burtenshaw burtenshaw marked this pull request as draft December 9, 2024 09:31
@burtenshaw
Copy link
Collaborator

@ViniFBN Thanks for this!

I've converted the PR to a draft, set to ready when you want to merge. Just note this:

  • you can open PRs on each module or the entire course. Whatever works for you.
  • we won't merge english content inside pt-br/ because it confuses users
  • when the Portuguese translation is complete, I'll assign a review for the whole course.
  • when we have a complete translation, I will move the english course to en/

😄

@burtenshaw
Copy link
Collaborator

Hey @ViniFBN . How's it going on this? I can merge just module 1 of the translation if you like?

@ViniFBN
Copy link
Contributor Author

ViniFBN commented Dec 11, 2024

Give me 2 minutes, I'm actually finishing the last cell of the last notebook of module 1 haha

Translated the whole content of module 1 to pt-br
@ViniFBN
Copy link
Contributor Author

ViniFBN commented Dec 11, 2024

Hey @ViniFBN . How's it going on this? I can merge just module 1 of the translation if you like?

The initial part is ready to merge, module 2 will be done today and tomorrow.

@burtenshaw burtenshaw marked this pull request as ready for review December 11, 2024 16:07
Copy link
Collaborator

@burtenshaw burtenshaw left a comment

Choose a reason for hiding this comment

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

Thanks!

Structurally, this looks great. I will look for a pt speaking reviewer when the course is complete.

@burtenshaw burtenshaw merged commit 79b5ef6 into huggingface:main Dec 11, 2024
zcasanova pushed a commit to zcasanova/smol-course that referenced this pull request Dec 27, 2024
[TRANSLATION] Add initial files and introduction to the course (main README.md) EN -> pt-BR translation
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.

2 participants