ftuneai 0.2.0__tar.gz

ftuneai-0.2.0/.devcontainer/devcontainer.json

@@ -0,0 +1,33 @@
+{
+  "name": "Python 3",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bookworm",
+  "customizations": {
+    "codespaces": {
+      "openFiles": [
+        "README.md",
+        "streamlit_app.py"
+      ]
+    },
+    "vscode": {
+      "settings": {},
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance"
+      ]
+    }
+  },
+  "updateContentCommand": "[ -f packages.txt ] && sudo apt update && sudo apt upgrade -y && sudo xargs apt install -y <packages.txt; [ -f requirements.txt ] && pip3 install --user -r requirements.txt; pip3 install --user streamlit; echo '✅ Packages installed and Requirements met'",
+  "postAttachCommand": {
+    "server": "streamlit run streamlit_app.py --server.enableCORS false --server.enableXsrfProtection false"
+  },
+  "portsAttributes": {
+    "8501": {
+      "label": "Application",
+      "onAutoForward": "openPreview"
+    }
+  },
+  "forwardPorts": [
+    8501
+  ]
+}

ftuneai-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pyyaml pytest pytest-cov
+
+      - name: Run tests
+        run: |
+          PYTHONPATH=src pytest tests/ -v --tb=short
+
+      - name: Run examples (smoke test)
+        run: |
+          PYTHONPATH=src python examples/basic_memory.py
+          PYTHONPATH=src python examples/validate.py
+
+  type-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pyyaml mypy types-PyYAML
+
+      - name: Run mypy
+        run: |
+          PYTHONPATH=src mypy src/ftune/ --ignore-missing-imports

ftuneai-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ftuneai-0.2.0/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE / tools
+.vscode/
+.idea/
+.claude/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Generated
+docs/
+
+# OS
+.DS_Store
+Thumbs.db
+*.docx

ftuneai-0.2.0/.streamlit/config.toml

@@ -0,0 +1,12 @@
+[theme]
+primaryColor = "#6C63FF"
+backgroundColor = "#0E1117"
+secondaryBackgroundColor = "#1A1A2E"
+textColor = "#FAFAFA"
+font = "sans serif"
+
+[server]
+headless = true
+
+[browser]
+gatherUsageStats = false

ftuneai-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing to ftune
+
+Thanks for your interest in contributing! Here's how you can help.
+
+## 🏆 Highest-Impact Contributions
+
+### 1. Validate Estimates (Most Wanted!)
+Run ftune against your actual training runs and share the results. This helps everyone calibrate expectations.
+
+```python
+from ftune import Estimator
+from ftune.validation import Validator, ActualMetrics
+
+est = Estimator(model="your-model", method="qlora", quantization="4bit", ...)
+actual = ActualMetrics(
+    peak_memory_gb=...,       # from nvidia-smi
+    training_time_hours=...,   # wall-clock
+    gpu_name="...",
+    dataset_size=...,
+    epochs=...,
+)
+result = Validator.compare(est, actual)
+print(Validator.format_report(result))
+```
+
+Open an issue or PR with your validation report!
+
+### 2. Update Pricing Data
+Cloud GPU pricing changes frequently. Help keep `src/ftune/data/pricing.yaml` current.
+
+### 3. Add Models
+Add new model specs to `src/ftune/data/models.yaml`. Include: parameters, hidden_size, num_layers, num_attention_heads, num_kv_heads, intermediate_size, vocab_size, max_seq_length.
+
+### 4. Add GPUs
+Add new GPU specs to `src/ftune/data/gpus.yaml`. Include: vram_gb, fp16_tflops, bf16_tflops, fp32_tflops, memory_bandwidth_gbps.
+
+## Development Setup
+
+```bash
+git clone https://github.com/ritikmahy5/ftune.git
+cd ftune
+
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+PYTHONPATH=src pytest tests/ -v
+
+# Run the CLI (needs extras)
+pip install typer rich
+PYTHONPATH=src python -m ftune estimate --model meta-llama/Llama-3.1-8B --method qlora
+
+# Run the web UI
+pip install streamlit pandas altair
+PYTHONPATH=src streamlit run src/ftune/app.py
+```
+
+## Code Style
+
+- Type hints on all functions
+- Docstrings on all public methods
+- Keep zero ML dependencies in core (no torch/transformers)
+- Run `ruff check src/` before submitting
+
+## Pull Request Process
+
+1. Fork the repo and create a feature branch
+2. Add tests for any new functionality
+3. Ensure all tests pass: `PYTHONPATH=src pytest tests/ -v`
+4. Submit a PR with a clear description
+
+## Reporting Issues
+
+- For inaccurate estimates: include your model, config, actual metrics, and ftune output
+- For bugs: include Python version, OS, and full traceback
+- For feature requests: describe the use case and expected behavior

ftuneai-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ftune contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.