Software Engineering Best Practices, a Machine Learners Perspective
This repository is meant to serve as an opinionated, pedagogical guide on software engineering best practices for those of us in machine learning.
What is this guide NOT?
It is NOT a comprehensive overview of best practices in software engineering. It is a highly opinionated sampling of tools and ideas that are important for writing good code in a machine learning project. This includes linting, formatting and testing.
Who is this guide for?
Machine learners who are not currently following software engineering best practices in their projects but would like to.
What is machine learning specific about this guide?
In truth, nothing important. We use Python as the language of choice as it is popular in machine learning, and we write some machine learning specific tests. Otherwise, this guide could apply to (almost) any python project.
What tools will this guide cover?
Poetry, for managing virtual environments and package dependencies.flake8, for linting.black, for formatting.pytest, for testing.- GitHub Actions, for continous integration / continous development (CI/CD).
Follow along with the guide here: https://johngiorgi.github.io/se_best_practices_ml_perspective/.
1 maintainer
Metadata
1 maintainer
Release files for se-best-practices-ml-perspective 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| se_best_practices_ml_perspective-0.1.1.tar.gz | 6.9 kB | Without provenance | Details for se_best_practices_ml_perspective-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| se_best_practices_ml_perspective-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for se_best_practices_ml_perspective-0.1.1-py3-none-any.whl |
Total release size: 14.9 kB
Release files / se_best_practices_ml_perspective-0.1.1.tar.gz
| Download URL | se_best_practices_ml_perspective-0.1.1.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9b2899306412762afd5a5fcb5ceb89508d814cb4d72573c2e72fee0dbfa36eab
|
|
BLAKE2b-256 checksum How to use checksums |
08effd68477761ff3005cffc47958318ddc17d78324a4362ed5745130ae233ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.10 CPython/3.7.4 Darwin/19.6.0
|
Release files / se_best_practices_ml_perspective-0.1.1-py3-none-any.whl
| Download URL | se_best_practices_ml_perspective-0.1.1-py3-none-any.whl |
|---|---|
| Size | 8.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1e0d53651068d87b2fd459d3fa1d5a0f36ca79c571d51608929053378ff2665d
|
|
BLAKE2b-256 checksum How to use checksums |
411fb1857bb77955dec40931ac913ab34be1b994c3111a7988d6571c2f5b4e66
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.10 CPython/3.7.4 Darwin/19.6.0
|
Security for se-best-practices-ml-perspective 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
