trainpit 0.1.0__tar.gz

trainpit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Moriyuki-S
+
+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.

trainpit-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: trainpit
+Version: 0.1.0
+Summary: Rich CLI progress monitoring for machine learning training loops
+License-Expression: MIT
+Project-URL: Documentation, https://moriyuki-s.github.io/trainpit/
+Project-URL: Issues, https://github.com/Moriyuki-S/trainpit/issues
+Project-URL: Repository, https://github.com/Moriyuki-S/trainpit
+Keywords: cli,machine-learning,monitoring,training,tui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: textual>=8.2.7
+Dynamic: license-file
+
+# trainpit
+
+[![Quality](https://github.com/Moriyuki-S/trainpit/actions/workflows/quality.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/quality.yml)
+[![Pytest Linux](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-linux.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-linux.yml)
+[![Pytest macOS](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-macos.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-macos.yml)
+[![Pytest Windows](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-windows.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-windows.yml)
+[![Coverage](https://github.com/Moriyuki-S/trainpit/actions/workflows/coverage.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/coverage.yml)
+
+trainpit is a Python package for rich CLI progress monitoring in machine learning training loops.
+
+The goal is to make long-running training jobs easier to inspect from a terminal, with progress output that is useful during development, debugging, and experiment runs.
+
+## Status
+
+trainpit is in early development. The public `train` tracker API is available,
+and the Textual dashboard demo can display progress, metrics, learning curves,
+timing, events, custom panels, and configurable graph renderers. Renderer
+integration around the public tracker API is still evolving.
+
+## Requirements
+
+- Python 3.13 or later
+- uv for local development
+
+## Installation
+
+Install the latest published release:
+
+```sh
+pip install trainpit
+```
+
+In a uv-managed project:
+
+```sh
+uv add trainpit
+```
+
+Or install into the active virtual environment with uv:
+
+```sh
+uv pip install trainpit
+```
+
+Install from a local checkout for development:
+
+```sh
+uv sync --locked
+```
+
+For development, include the development dependency group:
+
+```sh
+uv sync --locked --all-extras --dev
+```
+
+Install Git hooks for local quality checks:
+
+```sh
+uv run pre-commit install --install-hooks
+```
+
+## Usage
+
+Wrap a training loop with the `train` tracker:
+
+```python
+from trainpit import train
+
+with train(total_epochs=3, total_steps=5, label="demo-run") as progress:
+    for epoch in range(1, 4):
+        progress.epoch(epoch)
+
+        for step in range(1, 6):
+            loss = 1.0 / (epoch * step)
+            progress.step(
+                step,
+                loss=loss,
+                metrics={"acc": step / 5},
+                learning_rate=0.0001,
+            )
+```
+
+See the documentation tutorial for a fuller walkthrough.
+
+A runnable notebook version is available at `examples/train_tutorial.ipynb`.
+
+To run a small PyTorch neural network example:
+
+```sh
+uv run --group examples python examples/torch_nn.py
+```
+
+This opens the Textual dashboard and updates progress, metrics, and learning
+curves while the model trains. Press `q` to close the dashboard after inspecting
+the final state.
+
+For non-interactive output:
+
+```sh
+uv run --group examples python examples/torch_nn.py --plain
+```
+
+To preview the Textual dashboard demo:
+
+```sh
+uv run python examples/textual_dashboard.py
+```
+
+To preview user-defined dashboard panels:
+
+```sh
+uv run python examples/custom_panels.py
+```
+
+## Development
+
+Run the test suite:
+
+```sh
+uv run pytest
+```
+
+Run tests with coverage:
+
+```sh
+uv run pytest --cov=trainpit --cov-report=term-missing --cov-report=xml
+```
+
+Run the configured pre-commit checks manually:
+
+```sh
+uv run pre-commit run --all-files
+uv run pre-commit run --hook-stage pre-push --all-files
+```
+
+Check formatting:
+
+```sh
+uv run ruff format --check .
+```
+
+Run lint checks:
+
+```sh
+uv run ruff check .
+```
+
+Build distribution artifacts:
+
+```sh
+uv build
+```
+
+Publish releases by merging the repository's `develop` branch into `main` with a
+pull request. The `Publish` workflow reads the version from `pyproject.toml`,
+creates a GitHub release tagged as `v<version>`, builds the source distribution
+and wheel, then uploads them to PyPI with Trusted Publishing.
+
+If a release for that version already exists, the workflow skips publishing so
+the same package version is not uploaded twice. Publishing a GitHub release
+manually also triggers the PyPI upload path.
+
+Before the first release, configure a PyPI Trusted Publisher for:
+
+- owner: `Moriyuki-S`
+- repository: `trainpit`
+- workflow: `publish.yml`
+- environment: `pypi`
+
+Before opening a pull request, run:
+
+```sh
+uv lock --check
+uv run ruff format --check .
+uv run ruff check .
+uv run pytest
+uv run pytest --cov=trainpit --cov-report=term-missing --cov-report=xml
+uv build
+```
+
+## CI
+
+GitHub Actions checks the following:
+
+- lockfile validation
+- formatting and linting with ruff
+- Python file compilation
+- package build
+- wheel installation in a temporary environment
+- pytest on Linux, macOS, and Windows
+- coverage on Linux with `coverage.xml` uploaded as an artifact
+- documentation builds with zensical
+
+On pull requests, each CI workflow updates a dedicated conversation comment with
+the overall job status, run link, commit, and step-level outcomes.
+
+Dependabot is configured for GitHub Actions, uv, and devcontainer updates.
+
+## Contributing
+
+Issues and pull requests are welcome while the project is taking shape.
+
+For code changes, please keep the scope focused and include tests when the change affects behavior. For larger changes, open an issue first so the approach can be discussed before implementation.
+
+## License
+
+MIT License.

trainpit-0.1.0/README.md

@@ -0,0 +1,208 @@
+# trainpit
+
+[![Quality](https://github.com/Moriyuki-S/trainpit/actions/workflows/quality.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/quality.yml)
+[![Pytest Linux](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-linux.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-linux.yml)
+[![Pytest macOS](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-macos.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-macos.yml)
+[![Pytest Windows](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-windows.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/pytest-windows.yml)
+[![Coverage](https://github.com/Moriyuki-S/trainpit/actions/workflows/coverage.yml/badge.svg)](https://github.com/Moriyuki-S/trainpit/actions/workflows/coverage.yml)
+
+trainpit is a Python package for rich CLI progress monitoring in machine learning training loops.
+
+The goal is to make long-running training jobs easier to inspect from a terminal, with progress output that is useful during development, debugging, and experiment runs.
+
+## Status
+
+trainpit is in early development. The public `train` tracker API is available,
+and the Textual dashboard demo can display progress, metrics, learning curves,
+timing, events, custom panels, and configurable graph renderers. Renderer
+integration around the public tracker API is still evolving.
+
+## Requirements
+
+- Python 3.13 or later
+- uv for local development
+
+## Installation
+
+Install the latest published release:
+
+```sh
+pip install trainpit
+```
+
+In a uv-managed project:
+
+```sh
+uv add trainpit
+```
+
+Or install into the active virtual environment with uv:
+
+```sh
+uv pip install trainpit
+```
+
+Install from a local checkout for development:
+
+```sh
+uv sync --locked
+```
+
+For development, include the development dependency group:
+
+```sh
+uv sync --locked --all-extras --dev
+```
+
+Install Git hooks for local quality checks:
+
+```sh
+uv run pre-commit install --install-hooks
+```
+
+## Usage
+
+Wrap a training loop with the `train` tracker:
+
+```python
+from trainpit import train
+
+with train(total_epochs=3, total_steps=5, label="demo-run") as progress:
+    for epoch in range(1, 4):
+        progress.epoch(epoch)
+
+        for step in range(1, 6):
+            loss = 1.0 / (epoch * step)
+            progress.step(
+                step,
+                loss=loss,
+                metrics={"acc": step / 5},
+                learning_rate=0.0001,
+            )
+```
+
+See the documentation tutorial for a fuller walkthrough.
+
+A runnable notebook version is available at `examples/train_tutorial.ipynb`.
+
+To run a small PyTorch neural network example:
+
+```sh
+uv run --group examples python examples/torch_nn.py
+```
+
+This opens the Textual dashboard and updates progress, metrics, and learning
+curves while the model trains. Press `q` to close the dashboard after inspecting
+the final state.
+
+For non-interactive output:
+
+```sh
+uv run --group examples python examples/torch_nn.py --plain
+```
+
+To preview the Textual dashboard demo:
+
+```sh
+uv run python examples/textual_dashboard.py
+```
+
+To preview user-defined dashboard panels:
+
+```sh
+uv run python examples/custom_panels.py
+```
+
+## Development
+
+Run the test suite:
+
+```sh
+uv run pytest
+```
+
+Run tests with coverage:
+
+```sh
+uv run pytest --cov=trainpit --cov-report=term-missing --cov-report=xml
+```
+
+Run the configured pre-commit checks manually:
+
+```sh
+uv run pre-commit run --all-files
+uv run pre-commit run --hook-stage pre-push --all-files
+```
+
+Check formatting:
+
+```sh
+uv run ruff format --check .
+```
+
+Run lint checks:
+
+```sh
+uv run ruff check .
+```
+
+Build distribution artifacts:
+
+```sh
+uv build
+```
+
+Publish releases by merging the repository's `develop` branch into `main` with a
+pull request. The `Publish` workflow reads the version from `pyproject.toml`,
+creates a GitHub release tagged as `v<version>`, builds the source distribution
+and wheel, then uploads them to PyPI with Trusted Publishing.
+
+If a release for that version already exists, the workflow skips publishing so
+the same package version is not uploaded twice. Publishing a GitHub release
+manually also triggers the PyPI upload path.
+
+Before the first release, configure a PyPI Trusted Publisher for:
+
+- owner: `Moriyuki-S`
+- repository: `trainpit`
+- workflow: `publish.yml`
+- environment: `pypi`
+
+Before opening a pull request, run:
+
+```sh
+uv lock --check
+uv run ruff format --check .
+uv run ruff check .
+uv run pytest
+uv run pytest --cov=trainpit --cov-report=term-missing --cov-report=xml
+uv build
+```
+
+## CI
+
+GitHub Actions checks the following:
+
+- lockfile validation
+- formatting and linting with ruff
+- Python file compilation
+- package build
+- wheel installation in a temporary environment
+- pytest on Linux, macOS, and Windows
+- coverage on Linux with `coverage.xml` uploaded as an artifact
+- documentation builds with zensical
+
+On pull requests, each CI workflow updates a dedicated conversation comment with
+the overall job status, run link, commit, and step-level outcomes.
+
+Dependabot is configured for GitHub Actions, uv, and devcontainer updates.
+
+## Contributing
+
+Issues and pull requests are welcome while the project is taking shape.
+
+For code changes, please keep the scope focused and include tests when the change affects behavior. For larger changes, open an issue first so the approach can be discussed before implementation.
+
+## License
+
+MIT License.

trainpit-0.1.0/pyproject.toml

@@ -0,0 +1,72 @@
+[project]
+name = "trainpit"
+version = "0.1.0"
+description = "Rich CLI progress monitoring for machine learning training loops"
+readme = "README.md"
+requires-python = ">=3.13"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["cli", "machine-learning", "monitoring", "training", "tui"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Monitoring",
+]
+dependencies = [
+    "pydantic>=2.0",
+    "textual>=8.2.7",
+]
+
+[project.urls]
+Documentation = "https://moriyuki-s.github.io/trainpit/"
+Issues = "https://github.com/Moriyuki-S/trainpit/issues"
+Repository = "https://github.com/Moriyuki-S/trainpit"
+
+[build-system]
+requires = ["setuptools>=82.0.1"]
+build-backend = "setuptools.build_meta"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.6.0",
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+    "ruff>=0.15.18",
+    "zensical>=0.0.46",
+]
+examples = [
+    "numpy>=2.4.6",
+    "torch>=2.12.0",
+]
+
+[tool.uv.sources]
+torch = [{ index = "pytorch-cpu" }]
+
+[[tool.uv.index]]
+name = "pytorch-cpu"
+url = "https://download.pytorch.org/whl/cpu"
+explicit = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+addopts = "-ra"
+testpaths = ["tests"]
+
+[tool.coverage.run]
+branch = true
+source = ["trainpit"]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+
+[tool.ruff]
+target-version = "py313"

trainpit-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

trainpit-0.1.0/src/trainpit/__init__.py

@@ -0,0 +1,5 @@
+"""Rich CLI progress monitoring for machine learning training loops."""
+
+from trainpit._tracker import TrainTracker, train
+
+__all__ = ["TrainTracker", "train"]