Update README, add Git-Friendly Jupyter, set up files to ignore, and format the Python codes. #2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Deleted all .DS_Store files to clean up unnecessary macOS system files. - Added a comprehensive .gitignore file to prevent .DS_Store and other unwanted files from being tracked in the future.
- Renamed `LICENSE.md` to `LICENSE` to follow common naming conventions. - Ensures consistency with standard license file naming practices.
- Replaced the placeholder README content with a detailed course overview. - Added a structured table of contents for easier navigation. - Included descriptions of Transformer Neural Networks and PyTorch implementations from Udacity’s course. - Updated repository structure and contribution guidelines.
- Added `.pre-commit-config.yaml` with `nbdev_clean` hook to clean Jupyter Notebooks. - Installed `nbdev` Git hooks to manage notebook merges. - Added `.gitattributes` to handle `.ipynb` merge conflicts using `nbdev-merge`. - Updated `.gitconfig` to include `nbdev_fix` for resolving merge conflicts.
- Updated the copyright year in LICENSE from 2012-2020 to 2012-2025.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces several improvements to enhance the repository's documentation, version control setup, code formatting, and Jupyter Notebook management. Key updates include:
Summary of Changes
📖 Updated README
🔧 Applied Git-Friendly Jupyter for Better Notebook Version Control
nbdev_clean,nbdev_export) in.pre-commit-config.yamlto:.pyfiles for better version control..gitattributesto manage.ipynbmerge conflicts more efficiently.📂 Refined
.gitignore.ipynb_checkpoints/) and macOS system files (.DS_Store)..nbdevand generated files are not tracked.📑 Notebook Formatting Improvements
['generated_text']→["generated_text"]).