orient_express 2.4.2__tar.gz → 3.0.0__tar.gz

orient_express-3.0.0/.dockerignore

@@ -0,0 +1,10 @@
+orient_express/artifacts
+**/*.onnx
+**/*.pth
+**/*.pt
+**/*.joblib
+**/*.ipynb
+**/__pycache__
+test-output
+.git
+.venv

orient_express-3.0.0/.github/workflows/workflow.yaml

@@ -0,0 +1,66 @@
+name: Test and publish
+
+on:
+  push:
+    branches: ["**"]
+    tags: ["v*"]
+
+jobs:
+  build-and-test:
+    name: Build and test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+    - name: Install dependencies
+      # onnxruntime-gpu (selected by platform marker on linux-x86_64) needs
+      # CUDA libs at import since 1.27; runners have none, so install the
+      # CPU wheel instead — same swap the serving Dockerfiles do.
+      run: |
+        uv sync --frozen --no-install-package onnxruntime-gpu
+        uv pip install "onnxruntime>=1.20,<2"
+    - name: Lint with ruff
+      run: uv run --no-sync ruff check .
+    - name: Check formatting with ruff
+      run: uv run --no-sync ruff format --check .
+    - name: Run tests with pytest
+      run: uv run --no-sync pytest
+    - name: Build a binary wheel and a source tarball
+      run: uv build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: build-and-test
+    environment: release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Check tag matches project version
+        run: |
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+          PROJECT_VERSION="$(uv version --short)"
+          if [ "$TAG_VERSION" != "$PROJECT_VERSION" ]; then
+            echo "Tag $GITHUB_REF_NAME does not match pyproject version $PROJECT_VERSION" >&2
+            exit 1
+          fi
+
+      - name: Build the package
+        run: uv build
+
+      - name: Upload package to PyPI
+        run: uv publish --token "$UV_PUBLISH_TOKEN"
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

orient_express-3.0.0/.gitignore

@@ -0,0 +1,177 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*~
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+.envrc
+.venv
+
+# Ignore artifacts:
+orient_express/artifacts/
+*.onnx
+*.pt
+*.pth
+
+# Local docker test outputs
+test-output/
+*.joblib
+/test.ipynb
+*.local.ipynb

orient_express-3.0.0/.python-version

@@ -0,0 +1 @@
+3.12

orient_express-3.0.0/Makefile

@@ -0,0 +1,134 @@
+# --- Development ---
+
+install:
+	uv sync
+
+fmt:
+	uv run ruff format .
+	uv run ruff check --fix .
+
+lint:
+	uv run ruff check .
+	uv run ruff format --check .
+
+test:
+	uv run pytest
+
+# Golden equivalence suite (internal — see tests/equivalence/README.md).
+# Requires ORIENT_EXPRESS_TEST_MANIFEST and GCP application-default creds;
+# equivalence-docker additionally needs GOOGLE_CLOUD_PROJECT.
+equivalence:
+	uv run pytest tests/equivalence -v
+
+equivalence-docker: build_local_image_onnx
+	GOOGLE_CLOUD_PROJECT=$(GOOGLE_CLOUD_PROJECT) \
+	ORIENT_EXPRESS_TEST_DOCKER_IMAGE=$(IMAGE_ONNX):$(IMAGE_ONNX_TAG)_local \
+	uv run pytest tests/equivalence -v
+
+# Work on a gitignored copy of the committed test notebook so ad-hoc cell
+# edits and outputs never end up in a commit. To update the committed
+# template, deliberately edit test_docker_image.ipynb itself.
+scratch-notebook:
+	cp -n test_docker_image.ipynb test_docker_image.local.ipynb
+	@echo "Opened copy: test_docker_image.local.ipynb (gitignored)"
+
+.PHONY: install fmt lint test equivalence equivalence-docker scratch-notebook
+
+# --- Docker images ---
+# Image tags track the library version in pyproject.toml (see
+# get_image_onnx_container_uri in orient_express/predictors/predictor.py).
+
+VERSION := $(shell uv version --short)
+
+XGBOOST_SCIKIT_LEARN := us-west1-docker.pkg.dev/shiftsmart-api/orient-express/xgboost-scikit-learn
+XGBOOST_TAG := v$(VERSION)
+
+IMAGE_ONNX := us-west1-docker.pkg.dev/shiftsmart-api/orient-express/image-onnx
+IMAGE_ONNX_TAG := v$(VERSION)
+
+GOOGLE_CLOUD_PROJECT ?=
+REGION ?= us-west1
+MODEL_NAME ?=
+IMAGE_URL ?=
+CONFIDENCE ?= 0.5
+
+# Looked up from Vertex AI Model Registry by MODEL_NAME if not provided.
+AIP_STORAGE_URI ?= $(shell gcloud ai models list \
+	--region=$(REGION) --project=$(GOOGLE_CLOUD_PROJECT) \
+	--filter='displayName=$(MODEL_NAME)' \
+	--sort-by='~createTime' --limit=1 \
+	--format='value(name)' | \
+	xargs -I {} gcloud ai models describe {} \
+	--region=$(REGION) --project=$(GOOGLE_CLOUD_PROJECT) \
+	--format='value(artifactUri)')
+
+print_aip_storage_uri:
+	@echo "REGION=$(REGION)"
+	@echo "GOOGLE_CLOUD_PROJECT=$(GOOGLE_CLOUD_PROJECT)"
+	@echo "MODEL_NAME=$(MODEL_NAME)"
+	@echo "--- step 1: model resource name ---"
+	@gcloud ai models list \
+		--region=$(REGION) --project=$(GOOGLE_CLOUD_PROJECT) \
+		--filter='displayName=$(MODEL_NAME)' \
+		--sort-by='~createTime' --limit=1 \
+		--format='value(name)'
+	@echo "--- step 2: artifact URI ---"
+	@gcloud ai models list \
+		--region=$(REGION) --project=$(GOOGLE_CLOUD_PROJECT) \
+		--filter='displayName=$(MODEL_NAME)' \
+		--sort-by='~createTime' --limit=1 \
+		--format='value(name)' | \
+	xargs -I {} gcloud ai models describe {} \
+		--region=$(REGION) --project=$(GOOGLE_CLOUD_PROJECT) \
+		--format='value(artifactUri)'
+	@echo "--- resolved AIP_STORAGE_URI ---"
+	@echo $(AIP_STORAGE_URI)
+
+build_local_xgboost_scikit_learn:
+	docker buildx build --tag $(XGBOOST_SCIKIT_LEARN):$(XGBOOST_TAG)_local -f docker-xgboost-scikit-learn/Dockerfile .
+
+build_xgboost_scikit_learn:
+	docker buildx build --platform linux/amd64 --tag $(XGBOOST_SCIKIT_LEARN):$(XGBOOST_TAG) -f docker-xgboost-scikit-learn/Dockerfile .
+
+push_xgboost_scikit_learn: build_xgboost_scikit_learn
+	docker push $(XGBOOST_SCIKIT_LEARN):$(XGBOOST_TAG)
+
+run_local_xgboost_scikit_learn:
+	docker run --rm \
+		-v ~/.config/gcloud/application_default_credentials.json:/root/.config/gcloud/application_default_credentials.json:ro \
+		-e GOOGLE_APPLICATION_CREDENTIALS=/root/.config/gcloud/application_default_credentials.json \
+		-e GOOGLE_CLOUD_PROJECT=$(GOOGLE_CLOUD_PROJECT) \
+		-e AIP_STORAGE_URI=$(AIP_STORAGE_URI) \
+		-e MODEL_NAME=$(MODEL_NAME) \
+		-p 8080:8080 $(XGBOOST_SCIKIT_LEARN):$(XGBOOST_TAG)_local
+
+build_local_image_onnx:
+	docker buildx build --tag $(IMAGE_ONNX):$(IMAGE_ONNX_TAG)_local -f docker-image-onnx/Dockerfile .
+
+build_image_onnx:
+	docker buildx build --platform linux/amd64 --tag $(IMAGE_ONNX):$(IMAGE_ONNX_TAG) -f docker-image-onnx/Dockerfile .
+
+push_image_onnx: build_image_onnx
+	docker push $(IMAGE_ONNX):$(IMAGE_ONNX_TAG)
+
+run_local_image_onnx:
+	docker run --rm \
+		-v ~/.config/gcloud/application_default_credentials.json:/root/.config/gcloud/application_default_credentials.json:ro \
+		-e GOOGLE_APPLICATION_CREDENTIALS=/root/.config/gcloud/application_default_credentials.json \
+		-e GOOGLE_CLOUD_PROJECT=$(GOOGLE_CLOUD_PROJECT) \
+		-e AIP_STORAGE_URI=$(AIP_STORAGE_URI) \
+		-e MODEL_NAME=$(MODEL_NAME) \
+		-p 8080:8080 $(IMAGE_ONNX):$(IMAGE_ONNX_TAG)_local
+
+test_image_onnx:
+	mkdir -p test-output
+	@RESP=$$(mktemp); \
+	trap "rm -f $$RESP" EXIT; \
+	curl -s -X POST http://localhost:8080/v1/models/$(MODEL_NAME):predict \
+		-H "Content-Type: application/json" \
+		-d '{"instances": [{"image": "$(IMAGE_URL)"}], "parameters": {"confidence": $(CONFIDENCE)}}' \
+		-o $$RESP && \
+	jq -r '.predictions[0].debug_image // empty' $$RESP | base64 -d > test-output/debug_image.jpg && \
+	jq -r '.predictions[0].predictions.class_mask // empty' $$RESP | base64 -d > test-output/class_mask.png && \
+	jq -r '.predictions[0].predictions.valid_mask // empty' $$RESP | base64 -d > test-output/valid_mask.png && \
+	jq 'del(.predictions[].debug_image?, .predictions[].predictions.class_mask?, .predictions[].predictions.valid_mask?)' $$RESP > test-output/response.json