README.md

~trainer

A web dashboard for training machine learning models with PyTorch.

Built With

Getting Started

Prerequisites

Before attempting to build this project, make sure you have Python 3.10 or higher, just, and uv installed on your machine.

Installation

To get a local copy of the project up and running on your machine, follow these simple steps:

1. Clone the project repository

   git clone https://github.com/Kaweees/trainer.git
   cd trainer

2. Install the virtual environment and pre-commit hooks

   nix-shell
   not using NixOS

3. Set up environment variables

   cp .env.example .env

   Edit the .env file values to reflect your environment.

4. Run the project

   just run <package_name>

   The dashboard will be available at http://localhost:8000.

Project Structure

trainer/
├── .github/                       - GitHub Actions CI/CD workflows
├── scripts/                       - Standalone scripts
├── shared/
│   └── utils/                     - Shared utility functions
├── src/                           - Project packages
│   ├── core/                      - Core application logic
│   └── ...                        - Other packages
├── tests/                         - Project tests (mirrors the main project structure)
├── .env.example                   - Reference environment variables file
├── LICENSE                        - Project license
└── README.md                      - You are here

License

The source code for this project is distributed under the terms of the MIT License, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See LICENSE for details and more information.