Home

Awesome

Deep Learning v2 PyTorch

CI codecov License PyPI - Python Version PyPI pre-commit Code style: black powered by semgrep Dependabot


Documentation: https://deep-learning-v2-pytorch.readthedocs.io

Source Code: https://github.com/TeoZosa/deep-learning-v2-pytorch


Overview

Fork of udacity/deep-learning-v2-pytorch


Table of Contents

<!-- toc --> <!-- tocstop -->

Tutorials

Introduction to Neural Networks

Convolutional Neural Networks

Recurrent Neural Networks

Generative Adversarial Networks

Deploying a Model (with AWS SageMaker)

Projects

Elective Material

Development

📝 Note
For convenience, many of the below processes are abstracted away and encapsulated in single Make targets.

🔥 Tip
Invoking make without any arguments will display auto-generated documentation on available commands.

Package and Dependencies Installation

Make sure you have Python 3.6+ and poetry installed and configured.

To install the package and all dev dependencies, run:

make provision_environment

🔥 Tip
Invoking the above without poetry installed will emit a helpful error message letting you know how you can install poetry.

Testing

We use tox for our test automation framework and pytest for our testing framework.

To invoke the tests, run:

make test

Run mutation tests to validate test suite robustness (Optional):

make test-mutations

📝 Note
Test time scales with the complexity of the codebase. Results are cached in .mutmut-cache, so once you get past the initial cold start problem, subsequent mutation test runs will be much faster; new mutations will only be applied to modified code paths.

Code Quality

We are using pre-commit for our code quality static analysis automation and management framework.

To invoke the analyses and auto-formatting over all version-controlled files, run:

make lint

🚨 Danger
CI will fail if either testing or code quality fail, so it is recommended to automatically run the above locally prior to every commit that is pushed.

Automate via Git Pre-Commit Hooks

To automatically run code quality validation on every commit (over to-be-committed files), run:

make install-pre-commit-hooks

⚠️ Warning
This will prevent commits if any single pre-commit hook fails (unless it is allowed to fail) or a file is modified by an auto-formatting job; in the latter case, you may simply repeat the commit and it should pass.

Documentation

make docs-clean docs-html

📝 Note
For faster feedback loops, this will attempt to automatically open the newly built documentation static HTML in your browser.


Legal

License

Deep Learning v2 PyTorch is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Credits

This project was generated from @TeoZosa's cookiecutter-cruft-poetry-tox-pre-commit-ci-cd template.