Merge pull request #12 from acceleratescience/11-migrate-to-uv

Migrate to uv

Author: rkdan

.gitignore

@@ -1,9 +1,16 @@
-/venv
+venv/
 docs/.DS_Store
 /notebooks/data/
 
 /data
 /ignore
 
 .DS_Store
-__pycache__
+__pycache__
+
+# PyCharm project files
+# These files are machine specific and not useful to developers on VS Code or other editors
+.idea/
+
+# Python package build artifacts
+*.egg-info/

docs/Introduction/running-locally.md

@@ -0,0 +1,70 @@
+# Running Locally
+
+You can run the notebooks locally on your own machine by following the steps below.
+
+We recommend using `uv` for dependencies as it is much faster and automatically manages a `.venv` for you.
+
+However, you can also install dependencies with plain `pip` if you prefer.
+
+>
+> PyTorch (`torch`) is **not included** in the installation instructions below. PyTorch wheels differ depending on your system and can be very large if installed incorrectly. 
+> 
+> Please install the version suitable for your setup by following the [official PyTorch installation guide](https://pytorch.org/get-started/locally/).
+
+## 1. Cloning the repository
+Clone the repository to your machine:
+```bash
+git clone https://github.com/acceleratescience/diffusion-models
+cd diffusion-models
+```
+Alternatively, if you're using an IDE such as VS Code or PyCharm, you can paste the repository URL directly into the IDE's respective clone repository UI.
+
+## 2. Installing dependencies with `uv` (preferred)
+### Windows (Powershell)
+Install uv if needed:
+```bash
+irm https://astral.sh/uv/install.ps1 | iex
+```
+Create the virtual environment and install dependencies:
+```bash
+uv sync
+```
+Finally, activate the environment:
+```bash
+.\.venv\Scripts\activate
+```
+### macOS / Linux
+Install uv if needed:
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+Create the virtual environment and install dependencies:
+```bash
+uv sync
+```
+Finally, activate the environment:
+```bash
+source .venv/bin/activate
+```
+
+## 3. Installing dependencies with `pip` (alternative)
+### Windows (Powershell)
+Create and activate an empty virtual environment:
+```bash
+python3 -m diffusion-models .venv
+.\.venv\Scripts\activate
+```
+Finally, install dependencies to virtual environment:
+```bash
+pip install .
+```
+### macOS / Linux
+Create and activate an empty virtual environment:
+```bash
+python3 -m diffusion-models .venv
+source .venv\bin\activate
+```
+Finally, install dependencies to virtual environment:
+```bash
+pip install .
+```

mkdocs.yml

@@ -7,7 +7,9 @@ nav:
     - The Workshop: Home/workshop.md
     - License: Home/LICENSE.md
     - About us: Home/about.md
-  - Introduction: Introduction/Introduction.md
+  - Introduction:
+    - Introduction: Introduction/Introduction.md
+    - Running Locally: Introduction/running-locally.md
   - Physics: Physics/Physics.md
   - Building Blocks:
     - BuildingBlocks/index.md

pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "diffusion-models"
+version = "0.1.0"
+description = "A guide to working with diffusion models"
+authors = [
+    { name = "Ryan Daniels"},
+    { name = "Fin Griffin"},
+  ]
+license = { text = "GPL-3.0-or-later" }
+readme = "README.md"
+requires-python = ">=3.11,<4.0"
+dependencies = [
+    "matplotlib==3.9.0",
+    "seaborn==0.13.2",
+    "diffusers==0.28.2",
+    "transformers==4.41.2",
+    "scikit-learn>=1.5.2",
+    "ipykernel>=6.30.1",
+]
+
+[dependency-groups]
+dev = [
+  "mkdocs>=1.6.1,<2.0.0",
+  "mkdocs-pdf>=0.1.2",
+  "mkdocs-jupyter>=0.25.1",
+  "mkdocs-material>=9.5.44,<10.0.0",
+  "mkdocstrings>=0.27.0,<0.28.0",
+  "pre-commit>=4.3.0",
+]
+
+[tool.setuptools]
+packages = ["diffusion_models"]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"