Skip to main content

The opinionated deep learning template.

Project description

Deep Learning Project Template

Downloads GitHub release PyPI License: MIT Documentation Status Code style: black Open in Colab

The opinionated deep learning template.

Description

dlproject believes three things.

  1. All code should be documented.
  2. All experiments should be logged.
  3. Configs are better than constants.

Installation

These instructions assume you are using a linux machine with at least one GPU (CUDA 11.1).

  1. Create a new repository using this template and change to the root directory. For example,

    git clone git@github.com:benjamindkilleen/dlproject.git
    cd dlproject
    
  2. Install dependencies using either Anaconda (preferred) or Pip:

    • Anaconda: modify environment.yml to suit your needs. Then run:

      conda env create -f environment.yml
      conda activate dlproject
      

      This will create a new environment with the project installed as an edit-able package.

    • Pip: Install Pytorch to ensure GPU available. Then:

      pip install -r requirements.txt
      pip install -e .
      

Usage

The project is separated into "experiments," which are just different main functions. Use the experiment group parameter to change which experiment is running. For example:

python main.py experiment=mnist

The results are then neatly sorted into the newly-created results directory (ignored by default). This is important for reproduceability, utilizing Hydra's automatic logging and config storage.

Documentation

Documentation and tutorials for dlproject are available here. You should document your code as you go. If you use Visual Studio Code, this is an extension which will create Google style docstrings automatically.

To build the docstrings you write into a local static web-page, run

pip install -r docs/requirements.txt
sphinx-apidoc -f -o docs/source dlproject
cd docs
make html

And open /docs/build/html/index.html in your browser.

Citation

@article{YourName,
  title={Your Title},
  author={Your team},
  journal={Location},
  year={Year}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dlproject-0.1.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

dlproject-0.1.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file dlproject-0.1.1.tar.gz.

File metadata

  • Download URL: dlproject-0.1.1.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for dlproject-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4ed38b568ea1bd4c75754f97f22a7a4c27ddc5c27dbc120302fd387dfb12b305
MD5 3c0358dcecff02c964513769dbebb527
BLAKE2b-256 b0d5964515af514946767b381b17ff5004dbc744aac11d1dcad70aa4f3405fc3

See more details on using hashes here.

File details

Details for the file dlproject-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: dlproject-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for dlproject-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5ca7db395fa1a2cbe37510729f52850a9f904d06f281a2ff2428b09c663bc7b4
MD5 ee9e8d9829daa24e509f0627afd1cad4
BLAKE2b-256 c304d13b9c4a9b53ed46e7a273245fc2e2f23f244ddce8e552022ca8388e0a07

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page