-
Notifications
You must be signed in to change notification settings - Fork 71
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
Simple Clean up, .gitignore improved, PR template added #227
Changes from 11 commits
7b9c47c
819424b
2b0e24d
d85db25
fd42797
cecf7d1
606029e
6614c3a
ae93739
e863737
4cd325f
284fe55
08f028f
c228a12
37b0bd8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
## Summary | ||
|
||
> 🎯 **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 | ||
|
||
> 🌐 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 | ||
|
||
> 🔍 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. | ||
|
||
- | ||
|
||
## Links to Relevant Issues or Conversations | ||
|
||
> 🔗 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). | ||
> | ||
> 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. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,158 @@ | ||
# 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* | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does this line exclude .coveragerc? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes, it excludes There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We don't want to exclude it, can you please remove it? |
||
*.py,cover | ||
.hypothesis/** | ||
.pytest_cache/** | ||
|
||
# Misc | ||
results/ | ||
image_files* | ||
|
||
# datasets | ||
cifar* | ||
|
||
cleanlab/*.ipynb | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is not valid in this repo, please remove this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sure
smttsp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
tests/fasttext_data/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is not valid in this repo, please remove this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sure
smttsp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
data/ | ||
docs/_build/ | ||
|
||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is not valid in this repo, please remove this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. many of these are very common stuff in gitignore, in fact, most of these lines are coming from Github's default Python gitignore. I found being proactive much more effective than being retroactive. We will add common things now, but we won't need to add them to gitignore if/when it happens. Note that prior to this PR, when I set up my environment, I was seeing 30K files to be committed as the |
||
|
||
|
||
# PyInstaller | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is not valid in this repo, please remove this |
||
# 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Translations | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
*.log | ||
local_settings.py | ||
db.sqlite3 | ||
logs/ | ||
|
||
# Flask stuff: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
instance/ | ||
.webassets-cache | ||
|
||
# Scrapy stuff: | ||
.scrapy | ||
|
||
# Sphinx documentation | ||
build | ||
_build | ||
cleanlab-docs | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this
smttsp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# PyBuilder | ||
target/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# pyenv | ||
.python-version | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this
smttsp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# celery beat schedule file | ||
celerybeat-schedule | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this
smttsp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# SageMath parsed files | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
*.sage.py | ||
|
||
# Environments | ||
.env | ||
.venv | ||
env/ | ||
venv/ | ||
ENV/ | ||
env.bak/ | ||
venv.bak/ | ||
.direnv | ||
|
||
# Spyder project settings | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
.spyderproject | ||
.spyproject | ||
|
||
# Rope project settings | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
.ropeproject | ||
|
||
# mkdocs documentation | ||
/site | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
|
||
# mypy | ||
.mypy_cache/ | ||
|
||
# Downloaded datasets for docs | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This section is not valid in this repo, please remove this |
||
/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/ | ||
smttsp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# IPython | ||
profile_default/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not valid in this repo, please remove this |
||
ipython_config.py | ||
__pypackages__/ | ||
|
||
|
||
# Data files | ||
smttsp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
**.zip | ||
**-ubyte | ||
**.gz | ||
**.tar | ||
**.7Z | ||
**.BZ2 | ||
**.rar | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this line exclude MANIFEST.in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, it doesnt exclude
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you still remove it? I think it's confusing since we have a MANIFEST.in file