From 7b9c47c125cd3c64e0e84c5d5605b534c58da8f8 Mon Sep 17 00:00:00 2001 From: Samet Date: Wed, 4 Oct 2023 23:10:17 -0400 Subject: [PATCH 01/14] .gitignore updated, added env related stuff etc --- .gitignore | 133 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 132 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index bfcf8355..15eaa056 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ -.idea/ .DS_Store __pycache__/ .vscode/ @@ -21,3 +20,135 @@ image_files* # datasets cifar* + +# Byte-compiled / optimized / DLL files +*.py[cod] +*$py.class +.direnv +.idea +.idea/** +.vscode +.vscode/** + +# C extensions +*.so +**.txt + +# Distribution / packaging +.Python +develop-eggs/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage* +.cache +nosetests.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# IPython +profile_default/ +ipython_config.py + +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# Data files +**/*.json +*.csv +**.zip +**-ubyte +**.gz + +outputs/* +**.pth +**.pt +_data/** +_model/** +wandb/** + +ENV/** From 819424bcb25eb430354cb06018207e269e94e165 Mon Sep 17 00:00:00 2001 From: Samet Date: Wed, 4 Oct 2023 23:16:26 -0400 Subject: [PATCH 02/14] PR template added --- .github/pull_request_template.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..b1d65e98 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ +## Summary + +> What is the reason for this Pull-Request? Are you bumping the version? + + + +## Impact + +> What is the scope of your changes and who/where do you think they will affect? + + + +## Testing + +> What testing have you done and verified? If you can't test, please say why that is. + +- + +## Ticket(s) or Conversations + +> What Git or Slack items (Issues, threads etc) are specifically related to this work? Please link them here. + + +## References + +> Do you have any relevant URLs or Wiki pages that could help give background information for the changes in this Pull-Request? These are usually StackOverflow posts, Notion wiki pages, Wikipedia articles, or links to APIs and Documentation of third-party packages. + +- From 2b0e24d8b12bcf983208b8dc8eada4890aa83bd2 Mon Sep 17 00:00:00 2001 From: Samet Date: Wed, 4 Oct 2023 23:51:38 -0400 Subject: [PATCH 03/14] Update .github/pull_request_template.md Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com> --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b1d65e98..9f522263 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ ## Summary -> What is the reason for this Pull-Request? Are you bumping the version? +> What is the reason for this Pull-Request? From d85db25b5a55269590f97b83f104969612d4dd4e Mon Sep 17 00:00:00 2001 From: Samet Date: Thu, 5 Oct 2023 00:00:13 -0400 Subject: [PATCH 04/14] Update .github/pull_request_template.md Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com> --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9f522263..4b6a3e70 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,7 +12,7 @@ ## Testing -> What testing have you done and verified? If you can't test, please say why that is. +> What testing have you done and verified? Please link to the one unit test that is most end-to-end check of your new functionality. It's ok if your unit tests are not yet comprehensive when you first open the PR, we can revisit them later! - From fd4279742f9d63658f1d3db367df12ba43d1c495 Mon Sep 17 00:00:00 2001 From: Samet Date: Thu, 5 Oct 2023 00:12:04 -0400 Subject: [PATCH 05/14] Update .github/pull_request_template.md Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com> --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4b6a3e70..bc000a99 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -23,6 +23,6 @@ ## References -> Do you have any relevant URLs or Wiki pages that could help give background information for the changes in this Pull-Request? These are usually StackOverflow posts, Notion wiki pages, Wikipedia articles, or links to APIs and Documentation of third-party packages. +> Include any extra information that may be helpful to reviewers of your Pull-Request here (e.g. relevant URLs or Wiki pages that could help give background information). If relevant, please include additional code snippets (and their outputs/return values) showing alternative ways to use your newly added methods. - From cecf7d1aaa0afb489c607f57401b62079c1d3a9f Mon Sep 17 00:00:00 2001 From: Samet Date: Thu, 5 Oct 2023 00:21:43 -0400 Subject: [PATCH 06/14] removed txt, csv, json, pth, pth, _data etc --- .gitignore | 9 --------- 1 file changed, 9 deletions(-) diff --git a/.gitignore b/.gitignore index 15eaa056..27b75e87 100644 --- a/.gitignore +++ b/.gitignore @@ -32,7 +32,6 @@ cifar* # C extensions *.so -**.txt # Distribution / packaging .Python @@ -138,17 +137,9 @@ dmypy.json .pyre/ # Data files -**/*.json -*.csv **.zip **-ubyte **.gz outputs/* -**.pth -**.pt -_data/** -_model/** wandb/** - -ENV/** From 606029e02c3e1960c61ec0b62ccc2568db25a7a7 Mon Sep 17 00:00:00 2001 From: Samet Date: Thu, 5 Oct 2023 08:58:39 -0400 Subject: [PATCH 07/14] removed personal git preferences finalized the gitignore --- .gitignore | 90 +++++++++++++++--------------------------------------- 1 file changed, 24 insertions(+), 66 deletions(-) diff --git a/.gitignore b/.gitignore index 27b75e87..58007fa1 100644 --- a/.gitignore +++ b/.gitignore @@ -24,19 +24,29 @@ cifar* # Byte-compiled / optimized / DLL files *.py[cod] *$py.class -.direnv + +# development environment configuration files .idea .idea/** .vscode .vscode/** +# Python Environments +.direnv +.env +.venv +env/ +venv/ +env.bak/ +venv.bak/ + # C extensions *.so # Distribution / packaging .Python -develop-eggs/ -downloads/ +develop-eggs/** +downloads/** eggs/ .eggs/ lib/ @@ -49,13 +59,6 @@ pip-wheel-metadata/ share/python-wheels/ .installed.cfg *.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec # Installer logs pip-log.txt @@ -63,83 +66,38 @@ pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ -.tox/ -.nox/ .coverage* .cache -nosetests.xml *.cover *.py,cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot +.hypothesis/** +.pytest_cache/** -# Django stuff: +# log files *.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ +logs/** # IPython profile_default/ ipython_config.py - __pypackages__/ -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - # mkdocs documentation /site -# mypy +# mypy cache .mypy_cache/ .dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ # Data files **.zip **-ubyte **.gz +**.tar +**.7Z +**.BZ2 +**.rar -outputs/* +# other files +outputs/** wandb/** From 6614c3a53eac278bad71f07dfedeec41e7c07494 Mon Sep 17 00:00:00 2001 From: smttsp Date: Fri, 6 Oct 2023 08:49:45 -0400 Subject: [PATCH 08/14] Added the suggestion for PR_template --- .github/pull_request_template.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bc000a99..90c8fb7a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,8 @@ ## Summary -> What is the reason for this Pull-Request? +> What is the reason for this Pull-Request? If adding new functionality, please comment: +> a code snippet showcasing the end-to-end usage of your new methods, and the exact output +> from this code (print out any returned variables). @@ -12,17 +14,26 @@ ## Testing -> What testing have you done and verified? Please link to the one unit test that is most end-to-end check of your new functionality. It's ok if your unit tests are not yet comprehensive when you first open the PR, we can revisit them later! +> What testing have you done and verified? Please link to the one unit test +> that is most end-to-end check of your new functionality. It's ok if your +> unit tests are not yet comprehensive when you first open the PR, +> we can revisit them later! - ## Ticket(s) or Conversations -> What Git or Slack items (Issues, threads etc) are specifically related to this work? Please link them here. +> What Git or Slack items (Issues, threads, etc) that are specifically related to +> this work? Please link them here. +- ## References -> Include any extra information that may be helpful to reviewers of your Pull-Request here (e.g. relevant URLs or Wiki pages that could help give background information). If relevant, please include additional code snippets (and their outputs/return values) showing alternative ways to use your newly added methods. +> Include any extra information that may be helpful to reviewers of your +> Pull-Request here (e.g. relevant URLs or Wiki pages that could help give +> background information). If relevant, please include additional code snippets +> (and their outputs/return values) showing alternative ways to use your newly +> added methods. - From ae93739f5587466ad7e73c7544d8fbdd87d32f76 Mon Sep 17 00:00:00 2001 From: smttsp Date: Tue, 10 Oct 2023 19:57:58 -0400 Subject: [PATCH 09/14] updated PR template, impact section --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 90c8fb7a..1f49f0c4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,6 +9,8 @@ ## Impact > What is the scope of your changes and who/where do you think they will affect? +> If your change modifies documentation or a tutorial notebook, please include +> screenshots showing the rendered outputs for a quicker initial review. From e863737cde60740cada996b381c3d008ed9c02f3 Mon Sep 17 00:00:00 2001 From: smttsp Date: Fri, 13 Oct 2023 11:21:24 -0400 Subject: [PATCH 10/14] final pull request template --- .github/pull_request_template.md | 70 +++++++++++++++++++++++++------- 1 file changed, 55 insertions(+), 15 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1f49f0c4..b98be9fe 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,41 +1,81 @@ ## Summary -> What is the reason for this Pull-Request? If adding new functionality, please comment: -> a code snippet showcasing the end-to-end usage of your new methods, and the exact output -> from this code (print out any returned variables). +> 🎯 **Purpose**: Describe the objective of your changes in this Pull-Request. +> +> 📜 **Example Usage**: If adding new functionality, strive to provide a minimal working example (MWE) that demonstrates end-to-end usage and output of your new methods. If creating a MWE is not feasible, a conceptual code snippet showcasing the usage is also appreciated. Ensure that the code provided can be copied, pasted, and run without modifications. +**[ ✏️ Write your summary here. ]** +```python +# Example code snippet + +# Necessary Imports: +from my_module import my_new_function + +# Setup if needed (e.g., data loading, model instantiation): +a = 20 +b = 22 + +# Usage and Output: +result = my_new_function(a, b) +# 42 + +# ---- Your code below ---- +# [Replace the example above with your own code, ensuring it is executable and demonstrates your feature or fix.] +[your_uncommented_runnable_code_here] +# [your_output_here_as_a_comment] +``` ## Impact -> What is the scope of your changes and who/where do you think they will affect? -> If your change modifies documentation or a tutorial notebook, please include -> screenshots showing the rendered outputs for a quicker initial review. +> 🌐 Areas Affected: Enumerate modules, functions, or documentation impacted by your code. +> +> 👥 Who’s Affected: Mention who might be impacted (if applicable). + +**Screenshots** +> 📸 If your changes modify documentation or a tutorial notebook, please include screenshots or GIFs showing the rendered outputs for a quicker initial review, highlighting the main changes. ## Testing -> What testing have you done and verified? Please link to the one unit test -> that is most end-to-end check of your new functionality. It's ok if your -> unit tests are not yet comprehensive when you first open the PR, +> 🔍 Testing Done: Outline what kinds of tests you performed. +> +> 🔗 Test Case Link: Directly link to the most end-to-end check of your new functionality. + +**Unaddressed Cases** + +> It's ok if your unit tests are not yet +> comprehensive when you first open the PR, > we can revisit them later! +> +> ⚠️ Mention any aspects of testing that have *not* been covered, and why. - -## Ticket(s) or Conversations +## Links to Relevant Issues or Conversations -> What Git or Slack items (Issues, threads, etc) that are specifically related to +> 🔗 What Git or Slack items (Issues, threads, etc) that are specifically related to > this work? Please link them here. - ## References -> Include any extra information that may be helpful to reviewers of your +> 📚 Include any extra information that may be helpful to reviewers of your > Pull-Request here (e.g. relevant URLs or Wiki pages that could help give -> background information). If relevant, please include additional code snippets -> (and their outputs/return values) showing alternative ways to use your newly -> added methods. +> background information). +> +> Share links, docs, or sources that facilitated your changes. +> +> If relevant, please include additional code snippets +> (and their outputs/return values) showing alternative ways to use your newly added methods. + +```python +[additional code snippets and explanations] +``` - + +## Reviewer Notes +> 💡 Include any specific points for the reviewer to consider during their review. From 4cd325f10cee59112ded1f0a4b8e5a68a742b174 Mon Sep 17 00:00:00 2001 From: smttsp Date: Fri, 13 Oct 2023 11:25:59 -0400 Subject: [PATCH 11/14] updated gitignore, made it similar to cleanlab --- .gitignore | 159 +++++++++++++++++++++++++++++++++++------------------ 1 file changed, 107 insertions(+), 52 deletions(-) diff --git a/.gitignore b/.gitignore index 58007fa1..900230ff 100644 --- a/.gitignore +++ b/.gitignore @@ -1,18 +1,46 @@ +# editor/OS cache files +.idea/ .DS_Store -__pycache__/ .vscode/ +**/.DS_Store # jupyter notebooks .ipynb_checkpoints/ -# packaging +# Distribution / packaging +.Python +build/ +develop-eggs/ dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ *.egg-info/ -build/ +.installed.cfg +*.egg +MANIFEST -# Coverage +# Unit test / coverage reports +htmlcov/ +.tox/ .coverage +.coverage.* +.cache +nosetests.xml coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ +.coverage* +*.py,cover +.hypothesis/** +.pytest_cache/** # Misc results/ @@ -21,73 +49,103 @@ image_files* # datasets cifar* +cleanlab/*.ipynb +tests/fasttext_data/ +data/ +docs/_build/ + # Byte-compiled / optimized / DLL files +__pycache__/ *.py[cod] *$py.class -# development environment configuration files -.idea -.idea/** -.vscode -.vscode/** +# C extensions +*.so -# Python Environments -.direnv + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +logs/ + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +build +_build +cleanlab-docs + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments .env .venv env/ venv/ +ENV/ env.bak/ venv.bak/ +.direnv -# C extensions -*.so +# Spyder project settings +.spyderproject +.spyproject -# Distribution / packaging -.Python -develop-eggs/** -downloads/** -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -.installed.cfg -*.egg +# Rope project settings +.ropeproject -# Installer logs -pip-log.txt -pip-delete-this-directory.txt +# mkdocs documentation +/site -# Unit test / coverage reports -htmlcov/ -.coverage* -.cache -*.cover -*.py,cover -.hypothesis/** -.pytest_cache/** +# mypy +.mypy_cache/ -# log files -*.log -logs/** +# Downloaded datasets for docs +/docs/source/notebooks/aclImdb +/docs/source/notebooks/data +/docs/source/notebooks/*.gz +/docs/source/notebooks/spoken_digits +/docs/source/notebooks/pretrained_models +/docs/source/tutorials/datalab/datalab-files/ # IPython profile_default/ ipython_config.py __pypackages__/ -# mkdocs documentation -/site - -# mypy cache -.mypy_cache/ -.dmypy.json # Data files **.zip @@ -98,6 +156,3 @@ __pypackages__/ **.BZ2 **.rar -# other files -outputs/** -wandb/** From 284fe5573afd299ee0ede530a1bf2c69ae4db02d Mon Sep 17 00:00:00 2001 From: Samet Date: Mon, 16 Oct 2023 20:15:47 -0400 Subject: [PATCH 12/14] Update .gitignore --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 900230ff..c0e37add 100644 --- a/.gitignore +++ b/.gitignore @@ -49,7 +49,6 @@ image_files* # datasets cifar* -cleanlab/*.ipynb tests/fasttext_data/ data/ docs/_build/ From 08f028f40d8629a081466a8df3cd580af86a0e62 Mon Sep 17 00:00:00 2001 From: Samet Date: Mon, 16 Oct 2023 20:16:25 -0400 Subject: [PATCH 13/14] Apply suggestions from code review --- .gitignore | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/.gitignore b/.gitignore index c0e37add..498aba41 100644 --- a/.gitignore +++ b/.gitignore @@ -49,7 +49,6 @@ image_files* # datasets cifar* -tests/fasttext_data/ data/ docs/_build/ @@ -92,7 +91,6 @@ instance/ # Sphinx documentation build _build -cleanlab-docs # PyBuilder target/ @@ -101,10 +99,7 @@ target/ .ipynb_checkpoints # pyenv -.python-version -# celery beat schedule file -celerybeat-schedule # SageMath parsed files *.sage.py @@ -133,12 +128,6 @@ venv.bak/ .mypy_cache/ # Downloaded datasets for docs -/docs/source/notebooks/aclImdb -/docs/source/notebooks/data -/docs/source/notebooks/*.gz -/docs/source/notebooks/spoken_digits -/docs/source/notebooks/pretrained_models -/docs/source/tutorials/datalab/datalab-files/ # IPython profile_default/ From c228a12998acefd97977e1317908d116a4925c10 Mon Sep 17 00:00:00 2001 From: Sanjana Garg Date: Mon, 20 Nov 2023 13:19:39 -0800 Subject: [PATCH 14/14] Removed unecessary gitignore lines --- .gitignore | 99 +----------------------------------------------------- 1 file changed, 1 insertion(+), 98 deletions(-) diff --git a/.gitignore b/.gitignore index 498aba41..70d8294f 100644 --- a/.gitignore +++ b/.gitignore @@ -8,39 +8,13 @@ .ipynb_checkpoints/ # Distribution / packaging -.Python build/ -develop-eggs/ dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ *.egg-info/ -.installed.cfg -*.egg -MANIFEST # Unit test / coverage reports -htmlcov/ -.tox/ .coverage -.coverage.* -.cache -nosetests.xml coverage.xml -*.cover -.hypothesis/ -.pytest_cache/ -.coverage* -*.py,cover -.hypothesis/** -.pytest_cache/** # Misc results/ @@ -49,61 +23,12 @@ image_files* # datasets cifar* -data/ -docs/_build/ - # Byte-compiled / optimized / DLL files __pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -logs/ - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -build -_build - -# PyBuilder -target/ # Jupyter Notebook .ipynb_checkpoints -# pyenv - - -# SageMath parsed files -*.sage.py - # Environments .env .venv @@ -114,27 +39,6 @@ env.bak/ venv.bak/ .direnv -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ - -# Downloaded datasets for docs - -# IPython -profile_default/ -ipython_config.py -__pypackages__/ - - # Data files **.zip **-ubyte @@ -142,5 +46,4 @@ __pypackages__/ **.tar **.7Z **.BZ2 -**.rar - +**.rar \ No newline at end of file