Python Boilerplate with Pytorch GPU support

📙 Introduction

• PyTorch GPU boilerplate for deep learning projects.
• Also includes Ruff, Pre-commit, and Poetry set-up for a complete development environment.
• [Branch: devcontainer] Provides a devcontainer set-up for GitHub Codespaces and Visual Studio Code Remote Development.

🚀 Quick Start

1. Open Visual Studio Code with Remote Development

• Install Visual Studio Code and Remote Development Extension Pack.
• Connect to a (Case 1) Remote-SSH server or create a new (Case 2) Codespaces with this repository.
  1. (Recommend) How to Connect Remote-SSH
  2. Install GitHub Codespaces Extension and Create a new Codespaces with this repository. important! Check you have access to Codespaces plan. (free accounts does not support GPU machines.)
• ℹ️ Be aware that this devcontainer is set up for a GPU environment. you may need a gpu-enabled remote server or Codespaces.

2. Create your repository using template with the devcontainer branch

• Click the Use this template button on the top-right of this repository.
  • How to use a repository as a template
• Select the include all branches option to include the devcontainer branch.
• Click the Create repository button.

3. Open the repository in Visual Studio Code

• Open the repository in Remote Server or Codespaces.
• Click the Reopen in Container button to open the repository in the devcontainer.
  • You may need to install Docker if you are using a local machine.
• A new container will be created and the repository will be opened in the new container. (It may take a few minutes to build the container for the first time.)

4. Install additional dependencies

• Check Poetry Managing Dependencies for more information.
• Check Node Package Manager for more information.

Done! 🎉