feat: final review of the package and notebooks

[sdiazlor]

Updates in the package:

• Removed Transformers env var as it will be deprecated in favor of HF_HOME
• Deleted duplicated files with evaluation functions.
• Standardized the evaluate_model function to be used across the notebooks easily.
• Added create_comparison_plots and create_pareto_plot to be used accross the notebooks.

Updates in the README:

• Organized the notebooks according to the defined sections.
• Deleted the Transformers env var as it will be deprecated in favor of HF_HOME

Updates in the Notebooks:

• Deleted the 2. Utils section (now automatically triggered) and ensured all the sections are correct and not missed.
• Fixed the formatting:
  • Titles in upper case
  • Ruff formatted cells
  • Organized imports
  • Reviewed the comments in the code cells
• Fixed the links, crosslinks, and ensured the slides or documentation are correctly referenced for each notebook.
• Ensured the in-notebook functions are correctly defined with docstrings and typing.
• Reviewed the learning curve:
  • To Complete and ### End of complete where moved according to:
    • If it's the first time using the code structure, add a hint at the beginning
    • Avoid leaving empty cells
  • The first time functions are referenced, they create them in the notebook, then import them from the package, not for plotting functions
• Ran all the notebooks and deleted the no meaningful outputs

Current errors (in progress):

• Memory metrics don't work in baseline models (notebook 3)

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[review-notebook-app]

View / edit / reply to this conversation on ReviewNB

minettekaum commented on 2025-09-29T16:22:50Z
----------------------------------------------------------------

"By the end of this lecture, you will: ", I think it would feel less heavy if it said "part" or "chapter" instead of "lecture" :)

[review-notebook-app]

View / edit / reply to this conversation on ReviewNB

minettekaum commented on 2025-09-29T16:22:51Z
----------------------------------------------------------------

Line #12.        ### To Complete ###

I think it would be smart to give general instructions at the beginning, something like:

"There are some assignments in the code for you to complete, marked with ### To Complete ###..." This would help the people who do the course :)