Skip to main content

Cynex trajectory viewer integration for MLflow

Project description

mlflow-cynex

Cynex trajectory viewer integration for MLflow. Adds a "View in Cynex" button to MLflow's artifact browser for trajectory JSON files.

Installation

pip install mlflow-cynex
mlflow-cynex install

Then restart your MLflow server.

Usage

Logging Trajectories

The package provides a helper function to log trajectories to MLflow:

from mlflow_cynex import log_trajectory
import mlflow

mlflow.set_tracking_uri("http://localhost:5000")

with mlflow.start_run():
    trajectory = {
        "blue_agent_name": "PPO",
        "red_agent_name": "Meander",
        "episode": 0,
        "blue_actions": [...],
        "red_actions": [...],
        "metric_scores": [...],
        "network_topology": {...}
    }
    log_trajectory(trajectory)

The trajectory is automatically:

  • Validated against the expected schema
  • Saved to trajectories/<name>-trajectory.json in MLflow artifacts

Custom Naming

log_trajectory(trajectory, name="my-custom-name")
# Saved as: trajectories/my-custom-name.json

Validation Only

from mlflow_cynex import validate_trajectory, TrajectoryValidationError

try:
    validate_trajectory(data)
except TrajectoryValidationError as e:
    print(f"Invalid trajectory: {e}")

Trajectory Detection

The "View in Cynex" button appears for JSON files that:

  • Are in a trajectories/ folder, OR
  • Match *-trajectory.json or *_trajectory.json pattern

CLI Commands

mlflow-cynex install    # Install Cynex viewer into MLflow
mlflow-cynex uninstall  # Remove Cynex viewer from MLflow
mlflow-cynex status     # Check installation status

Development

Build from source:

cd cynex/mlflow-integration
./scripts/build.sh
pip install dist/mlflow_cynex-*.whl

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mlflow_cynex-0.1.13.tar.gz (759.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mlflow_cynex-0.1.13-py3-none-any.whl (765.0 kB view details)

Uploaded Python 3

File details

Details for the file mlflow_cynex-0.1.13.tar.gz.

File metadata

  • Download URL: mlflow_cynex-0.1.13.tar.gz
  • Upload date:
  • Size: 759.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mlflow_cynex-0.1.13.tar.gz
Algorithm Hash digest
SHA256 728526d54d9ba274c125723751a784a933ffffafd01e93363025cea86451062d
MD5 2587b77b4e6561ef8b74777cf73e3348
BLAKE2b-256 7aaa9a9a50b5ef4097c29dbabb3d9717006a3749ca23714b58115253cf6272f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for mlflow_cynex-0.1.13.tar.gz:

Publisher: publish-mlflow-cynex.yml on PaulHax/cynex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mlflow_cynex-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: mlflow_cynex-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 765.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mlflow_cynex-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 717a31015f106644a18eab463f97792119e255d85ea9e0912dc68b04e0a4d393
MD5 27ee855943870178c580850e5e912be5
BLAKE2b-256 fd15290ef908f5715748dadf784b7de1f9fd2032d7e12a5738c7f4c19fc5c6a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for mlflow_cynex-0.1.13-py3-none-any.whl:

Publisher: publish-mlflow-cynex.yml on PaulHax/cynex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page