fashion-mnist-classifier 0.1.1

An image classification model for Fashion MNIST using PyTorch Lightning.

Description

This project implements an image classification model based on the Fashion MNIST dataset, using PyTorch Lightning to structure the code in a modular and scalable way. The dataset is loaded directly from torchvision.datasets. The goal is to train a simple convolutional network that classifies images into 10 different clothing categories.

Project Structure

fashion-mnist-classifier/
├── models/               # Directory for saved models and checkpoints
├── reports/              # Evaluation reports and generated figures
├── src/
│   └── my_project/       # Project source code
│       ├── __init__.py
│       ├── app.py        # Gradio application
│       ├── config.py     # Configurations and parameters
│       ├── dataset.py    # Dataset and DataModule
│       ├── model.py      # PyTorch Lightning model
│       ├── plots.py      # Visualization functions
│       └── train.py      # Main training script
├── .gitignore
├── LICENSE               # Project license
├── pyproject.toml        # Project metadata and dependencies
└── README.md             # This file

Installation

To install dependencies and prepare the environment with uv, run the following commands in the terminal:

1. Download and install dependencies: curl -sSf https://uv.io/install.sh | sh
2. Initialize the environment: uv init
3. Sync dependencies and environment: uv sync

Training and Evaluation

To run the training and evaluation script, first install the package in editable mode:

uv pip install -e .

Then, run the following command in the terminal:

fashion-mnist-classifier

Building and Publishing to PyPI

To build and publish the package to PyPI, follow these steps:

1. Install build tools:

   uv pip install build twine
   

2. Build the package:

   python -m build
   

3. Publish to PyPI:

   twine upload dist/*
   

   You will be prompted for your PyPI username and password.

Technical Details

-Dataset: torchvision.datasets.FashionMNIST with custom transformations. -Model: Simple CNN with one convolutional layer, pooling, and fully connected layers. -Training: Implemented with PyTorch Lightning to facilitate handling epochs, performance, and metrics. -Configuration: Parameters such as batch size, paths, epochs defined in config.py. -Optimization: Adam with CrossEntropyLoss.

Reports & Visualizations

The project includes detailed reports and visualizations:

• Confusion matrix
• Per-class accuracy
• Calibration curve
• Misclassified image grids
• Pixel distribution analysis

All outputs are stored in the reports/ folder.

Contact

[e-mail] [e-mail] [e-mail]