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

Simple Clean up, .gitignore improved, PR template added #227

Merged
merged 15 commits into from
Nov 20, 2023
Merged
39 changes: 39 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## 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).



## 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? 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) 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.

-
82 changes: 81 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.idea/
.DS_Store
__pycache__/
smttsp marked this conversation as resolved.
Show resolved Hide resolved
.vscode/
Expand All @@ -21,3 +20,84 @@ image_files*

# datasets
cifar*

# Byte-compiled / optimized / DLL files
*.py[cod]
*$py.class

# 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/**
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
.installed.cfg
*.egg

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.coverage*
.cache
*.cover
*.py,cover
.hypothesis/**
.pytest_cache/**

# log files
smttsp marked this conversation as resolved.
Show resolved Hide resolved
*.log
logs/**

# IPython
profile_default/
Copy link
Member

Choose a reason for hiding this comment

The 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__/

# mkdocs documentation
/site

# mypy cache
.mypy_cache/
.dmypy.json

# Data files
smttsp marked this conversation as resolved.
Show resolved Hide resolved
**.zip
**-ubyte
**.gz
**.tar
**.7Z
**.BZ2
**.rar

# other files
outputs/**
smttsp marked this conversation as resolved.
Show resolved Hide resolved
wandb/**