https://github.com/prokil/python_project_template
https://github.com/prokil/python_project_template
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/prokil/python_project_template
- Owner: ProKil
- Created: 2023-08-12T21:31:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T20:19:20.000Z (over 1 year ago)
- Last Synced: 2025-02-20T21:26:55.816Z (over 1 year ago)
- Language: Python
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Best Practices in Open-Source Machine Learning Research Projects in Python: A Template
This template, designed as the optimal springboard for your open-source Python research projects, is an ideal choice if you:
1. Seek to enable other researchers to build upon your project with ease;
2. Aim to minimize the communication gap between your project's collaborators;
3. Aspire to iterate rapidly while maintaining high confidence that minor code changes won't disrupt the entire pipeline;
4. Desire to decrease the number of frustrating Runtime Errors encountered during experiment execution.
> [!NOTE]
> This repo is under construction.
## Pull Requests
A PR typically implements a new feature, improves an old feature, or fixes a bug.
## Typing
### Static type checking
### Dynamic type checking
## Continuous Integration
## Contribution
I welcome all kinds of contribution, e.g. adding more tools, better practices, discussions on trade-offs.