utrain 0.0.4__tar.gz

utrain-0.0.4/.gitignore

@@ -0,0 +1,7 @@
+.aleash*
+**/__pycache__/
+**/node_modules/
+frontend/dist
+.coverage*
+**/*.swp
+**/*.t.err

utrain-0.0.4/.gitlab-ci.yml

@@ -0,0 +1,195 @@
+# CI pipeline.
+#
+# check stage:   run the pre-commit hooks (`make check`) and the pytest suite on
+#                every push to main.
+# release stage: on tag pipelines, build every container preset under
+#                containers/<name>/ and push it to this project's GitLab
+#                container registry. The pre-commit hooks also run on tags (the
+#                check stage runs first), so a release only publishes if they pass.
+#                Once the images are built, publish-pypi builds the wheel/sdist
+#                with `uv build` and uploads them to PyPI.
+# deploy stage:  build the docs with zensical and publish them to GitLab Pages,
+#                one version per release tag plus a rolling "dev" for main. mike
+#                owns the `pages` branch -- it keeps every version there, and
+#                the job only unpacks that branch into public/. Nothing should
+#                commit to it by hand.
+#
+# Users pull a published preset with:
+#   utrain image add docker://$CI_REGISTRY_IMAGE/<name>:latest
+#
+# Prerequisites:
+#   - Container Registry enabled (Settings -> General -> Visibility).
+#   - Pages enabled (Settings -> General -> Visibility).
+#   - MIKE_ACCESS_TOKEN: a project access token with the write_repository scope,
+#     masked and protected, so the pages job can push to the `pages` branch.
+#   - PYPI_API_TOKEN: a PyPI API token (scoped to the utrain project once it
+#     exists on PyPI, or account-wide for the first publish), masked and
+#     protected, so publish-pypi can upload releases. gitlab.inria.fr is
+#     self-hosted, so PyPI trusted publishing (OIDC) isn't available -- it
+#     only supports gitlab.com.
+#   - runner has privileged = true
+
+stages: [check, release, deploy]
+
+pre-commit:
+  stage: check
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+  tags:
+    - self-linux
+  variables:
+    PRE_COMMIT_HOME: "$CI_PROJECT_DIR/.cache/pre-commit"
+    UV_CACHE_DIR: "$CI_PROJECT_DIR/.cache/uv"
+  cache:
+    key: pre-commit
+    paths:
+      - .cache/pre-commit
+      - .cache/uv
+  rules:
+    - if: '$CI_COMMIT_TAG'
+    - if: '$CI_COMMIT_BRANCH == "main"'
+  script:
+    - uv run --frozen pre-commit run --all-files --show-diff-on-failure
+
+test:
+  stage: check
+  image: quay.io/podman/stable
+  tags:
+    - self-linux
+  rules:
+    - if: '$CI_COMMIT_TAG'
+    - if: '$CI_COMMIT_BRANCH == "main"'
+  variables:
+    # vfs because the job's container storage is itself inside a container,
+    # where overlay needs a host mount it does not have. It is space-hungry --
+    # if this job starts failing on disk, give the runner a bigger volume.
+    STORAGE_DRIVER: vfs
+    UV_CACHE_DIR: "$CI_PROJECT_DIR/.cache/uv"
+  cache:
+    key: test
+    paths:
+      - .cache/uv
+  script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - export PATH="$HOME/.local/bin:$PATH"
+    - podman run --rm docker.io/library/busybox:latest true
+    # -rs prints every skip reason, so a suite that goes quiet in CI says why in
+    # the job log rather than just shrinking.
+    - uv run --frozen pytest -rs
+
+build-images:
+  stage: release
+  image:
+    # The :debug tag ships /busybox/sh so the shell loop below can run.
+    name: gcr.io/kaniko-project/executor:debug
+    entrypoint: [""]
+  tags:
+    - self-linux
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  script:
+    - mkdir -p /kaniko/.docker
+    - |
+      cat > /kaniko/.docker/config.json <<EOF
+      {"auths":{"$CI_REGISTRY":{"username":"$CI_REGISTRY_USER","password":"$CI_REGISTRY_PASSWORD"}}}
+      EOF
+    - |
+      for dir in containers/*/; do
+        name=$(basename "$dir")
+        [ -f "containers/$name/Containerfile" ] || continue
+        echo "Building and pushing $name"
+        /kaniko/executor \
+          --context "$CI_PROJECT_DIR" \
+          --dockerfile "containers/$name/Containerfile" \
+          --destination "$CI_REGISTRY_IMAGE/$name:$CI_COMMIT_TAG" \
+          --destination "$CI_REGISTRY_IMAGE/$name:latest"
+      done
+
+publish-pypi:
+  stage: release
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+  tags:
+    - self-linux
+  needs:
+    - job: build-images
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  before_script:
+    - |
+      if [ -z "$PYPI_API_TOKEN" ]; then
+        echo "PYPI_API_TOKEN is unset -- add it as a masked, protected CI/CD variable" >&2
+        exit 1
+      fi
+  script:
+    - uv build
+    - uv publish --token "$PYPI_API_TOKEN"
+
+pages:
+  stage: deploy
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+  tags:
+    - self-linux
+  needs:
+    - job: pre-commit
+      artifacts: false
+    - job: test
+      artifacts: false
+  rules:
+    - if: '$CI_COMMIT_TAG'
+    - if: '$CI_COMMIT_BRANCH == "main"'
+  # A tag is pushed right after the release commit, so the tag pipeline and the
+  # main pipeline overlap. Both push $MIKE_BRANCH; serialize them or the second
+  # one dies on a non-fast-forward.
+  resource_group: pages
+  variables:
+    UV_CACHE_DIR: "$CI_PROJECT_DIR/.cache/uv"
+    # mike appends to the published site by resetting the local branch to
+    # origin/$MIKE_BRANCH, comparing the two through their merge-base. A shallow
+    # clone has no merge-base to find.
+    GIT_DEPTH: "0"
+    # Where mike keeps the built site. mike itself takes this from
+    # `remote_branch` in zensical.toml; it is repeated here only for the two git
+    # commands below, so the two have to be changed together.
+    MIKE_BRANCH: pages
+  cache:
+    key:
+      files:
+        - uv.lock
+    paths:
+      - .cache/uv
+  before_script:
+    # The token has to be masked *and* protected: main and the release tags are
+    # protected refs, and an unprotected variable is simply absent here, which
+    # would otherwise surface as an opaque auth failure at push time.
+    - |
+      if [ -z "$MIKE_ACCESS_TOKEN" ]; then
+        echo "MIKE_ACCESS_TOKEN is unset -- add it as a masked, protected CI/CD variable" >&2
+        exit 1
+      fi
+    - uv sync --frozen
+    - git remote set-url origin "https://oauth2:${MIKE_ACCESS_TOKEN}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git"
+    - git config user.name "GitLab CI"
+    - git config user.email "gitlab-ci@$CI_SERVER_HOST"
+  script:
+    # --alias-type=copy because mike defaults to publishing an alias as a
+    # symlink to the version it points at, and GitLab Pages serves the artifact
+    # archive without resolving symlinks: "latest" would 404 while "1.2.3"
+    # works. set-default has no such option -- it always writes a real redirect.
+    - |
+      if [ -n "$CI_COMMIT_TAG" ]; then
+        uv run mike deploy --push --update-aliases --alias-type=copy "$CI_COMMIT_TAG" latest
+        uv run mike set-default --push latest
+      else
+        uv run mike deploy --push --update-aliases --alias-type=copy dev
+        # mike only creates the "/" redirect once "set-default" has been
+        # run at least once. Bootstrap it to "dev" so the site is reachable
+        # at "/" before the first release tag exists; once a tag has set
+        # the default to "latest", leave it alone on later dev pushes.
+        if ! git cat-file -e "$MIKE_BRANCH:index.html" 2>/dev/null; then
+          uv run mike set-default --push dev
+        fi
+      fi
+    - rm -rf public && mkdir public
+    - git archive "$MIKE_BRANCH" | tar -x -C public
+  artifacts:
+    paths:
+      - public

utrain-0.0.4/.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: \.t$
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: check-added-large-files
+        args: [--maxkb=1000]
+      - id: debug-statements
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.2
+    hooks:
+      - id: codespell
+        name: Spell check source files
+        exclude: frontend/package-lock.json
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.14
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: local
+    hooks:
+      - id: check-from-imports
+        name: Ban from-imports for everything except relative imports
+        entry: scripts/check-imports
+        language: system
+        types: [python]
+      - id: pyright
+        name: Type checking for python
+        entry: uv run --frozen pyright
+        language: system
+        types: [python]
+        pass_filenames: false
+      - id: licensecheck
+        name: License compatibility
+        entry: uv run --frozen licensecheck
+        language: system
+        pass_filenames: false
+      - id: uv-audit
+        name: Vulnerability scan (uv audit)
+        entry: uv audit
+        language: system
+        pass_filenames: false

utrain-0.0.4/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+<!-- towncrier release notes start -->
+
+## 0.0.4 (2026-08-18)
+
+No significant changes.
+
+
+## 0.0.3 (2026-08-18)
+
+No significant changes.
+
+
+## 0.0.2 (2026-08-17)
+
+No significant changes.

utrain-0.0.4/LICENSE

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

utrain-0.0.4/Makefile

@@ -0,0 +1,26 @@
+.PHONY: all presets frontend check cram FORCE
+
+all: presets
+
+frontend:
+	cd frontend &&  npm install && npm run build
+
+presets: containers/shakespeare-char
+
+containers/%: FORCE
+	podman build -t utrain-$*:utrain -f containers/$*/Containerfile .
+
+cram:
+	uv run pytest tests/test_cram.py
+
+check:
+	uv run pre-commit run --all-files
+
+cov:
+	@rm -rf .coverage .coverage.*
+	PYTHONUNBUFFERED=1 COVERAGE_PROCESS_START=$(shell pwd)/pyproject.toml COVERAGE_FILE=$(shell pwd)/.coverage uv run pytest
+
+cov-report:
+	COVERAGE_FILE=$(shell pwd)/.coverage uv run coverage combine --rcfile $(shell pwd)/pyproject.toml -a -q || true
+	COVERAGE_FILE=$(shell pwd)/.coverage uv run coverage html -d cov --rcfile $(shell pwd)/pyproject.toml
+	COVERAGE_FILE=$(shell pwd)/.coverage uv run coverage report

utrain-0.0.4/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.5
+Name: utrain
+Version: 0.0.4
+Summary: Local web UI for end-to-end LLM training
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: anyio>=4.0
+Requires-Dist: fastapi>=0.115
+Requires-Dist: naw>=0.0.4
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: uvicorn[standard]>=0.32

utrain-0.0.4/README.md

@@ -0,0 +1,14 @@
+# utrain
+
+UTrain is a python package that can be run on Linux hosts to manage local SLM training runs:
+- download and install training containers
+- configure your training run
+- monitor the status of your training run
+- check benchmark results
+- manually interact with your model for simple testing
+
+If you want to learn how to use utrain, head to our [Documentation](https://mlacage.gitlabpages.inria.fr/utrain).
+
+## License
+
+MIT — see [LICENSE](https://gitlab.inria.fr/mlacage/utrain/-/raw/main/LICENSE?ref_type=heads)

utrain-0.0.4/changes/1.bugfix.md

@@ -0,0 +1 @@
+build and publish release packages on pypi

utrain-0.0.4/containers/shakespeare-char/Containerfile

@@ -0,0 +1,6 @@
+FROM docker.io/python:3.11-slim
+WORKDIR /app
+RUN pip install --no-cache-dir torch --index-url https://download.pytorch.org/whl/cu121
+RUN pip install --no-cache-dir pyyaml wandb
+COPY containers/shakespeare-char/shakespeare_char.py /app/shakespeare_char.py
+ENTRYPOINT ["python", "/app/shakespeare_char.py"]