Skip to main content

A comprehensive ML experiment tracking library

Project description

PyPMLTracker: A Comprehensive ML Experiment Tracking Library

PyPMLTracker is a powerful and flexible experiment tracking library designed for machine learning projects. It helps data scientists and ML engineers efficiently track, visualize, and manage their experiments. Whether you're training models locally or in the cloud, PyPMLTracker provides all the tools you need to streamline your ML workflow and collaborate with your team.


Features ✨

  • 📊 Experiment Tracking: Log metrics, parameters, and artifacts during model training.
  • 🖥️ System Monitoring: Track CPU, memory, disk, and GPU usage during experiments.
  • 🔄 Framework Integrations: Native support for PyTorch, TensorFlow, and scikit-learn.
  • 📈 Visualization: Interactive dashboard to visualize and compare experiments.
  • 💾 Storage Options: Local storage and cloud storage (AWS S3) support.
  • 🌐 API: Client-server architecture for team collaboration.


🔧 Used Libraries & Tools

  • 🔗 PyTorch: PyTorch
  • 🔗 TensorFlow: TensorFlow
  • 🔗 scikit-learn: scikit-learn
  • ☁️ AWS S3: AWS
  • 📈 Plotly: Plotly
  • 📦 PyPMLTracker: PyPMLTracker

Installation ⚙️

Install PyPMLTracker

To install PyPMLTracker, use the following pip command:

pip install pypmltracker

Optional Features

You can install specific features based on your needs:

  • PyTorch integration:
pip install pypmltracker[pytorch]
  • TensorFlow integration:
pip install pypmltracker[tensorflow]
  • scikit-learn integration:
pip install pypmltracker[sklearn]
  • Cloud storage (AWS S3):
pip install pypmltracker[cloud]
  • All features (PyTorch, TensorFlow, scikit-learn, and Cloud):
pip install pypmltracker[all]

Quick Start 🚀

1. Initialize an Experiment

import pypmltracker

experiment = pypmltracker.Experiment(
    project_name="my_project",
    run_name="first_run",
    config={"learning_rate": 0.01, "batch_size": 32}
)
experiment.log({"accuracy": 0.85, "loss": 0.35})
experiment.log_artifact("model", "model.pkl")
experiment.finish()
dashboard = pypmltracker.Dashboard()
dashboard.start(open_browser=True)

Framework Integrations 🤖

PyPMLTracker integrates with several popular machine learning frameworks. Below are examples of how to use PyPMLTracker with PyTorch, TensorFlow, and scikit-learn.

import torch
import torch.nn as nn
import pypmltracker

experiment = pypmltracker.Experiment(project_name="pytorch_example")
tracker = pypmltracker.PyTorchTracker(experiment, log_gradients=True)
model = nn.Sequential(nn.Linear(10, 5), nn.ReLU(), nn.Linear(5, 1))
tracker.watch(model)

for epoch in range(10):
    loss = train_step(model, data)
    tracker.track_metrics({"loss": loss})
    val_accuracy = validate(model, val_data)
    tracker.on_epoch_end(epoch, model, {"val_accuracy": val_accuracy})
tracker.save_model(model, "final_model")

System Monitoring 🖥️

Track system resources such as CPU, memory, and disk usage during your experiments.

import pypmltracker
import time

experiment = pypmltracker.Experiment(project_name="system_monitoring")
monitor = pypmltracker.SystemMonitor(experiment)
monitor.start()

for i in range(10):
    time.sleep(1)
    experiment.log({"step": i, "value": i * 2})
monitor.stop()
experiment.finish()

Dashboard 📊

Start the PyPMLTracker web dashboard to visualize and compare your experiments.

import pypmltracker

dashboard = pypmltracker.Dashboard(
    storage_dir="./pypmltracker_data",
    host="127.0.0.1",
    port=8000
)
dashboard.start(open_browser=True)

Team Collaboration 🤝

PyPMLTracker supports client-server architecture to facilitate team collaboration.

  • Server Server Start the server to expose PyPMLTracker functionality via a REST API:
import pypmltracker

server = pypmltracker.PyPMLTrackerServer(
    storage_dir="./pypmltracker_data",
    host="0.0.0.0",
    port=5000,
    api_key="your-secret-api-key"
)
server.start()
  • Client 📡 Connect to the remote server and interact with it:
import pypmltracker

client = pypmltracker.PyPMLTrackerClient(
    base_url="http://server-address:5000",
    api_key="your-secret-api-key"
)
projects = client.list_projects()
print("Projects:", projects)

License 📜

PyPMLTracker is licensed under the MIT License.

Contributing 🤗

Contributions are welcome! If you’d like to contribute to the development of PyPMLTracker, please feel free to submit a pull request.

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

pypmltracker-0.1.1.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

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

pypmltracker-0.1.1-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file pypmltracker-0.1.1.tar.gz.

File metadata

  • Download URL: pypmltracker-0.1.1.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for pypmltracker-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3324d85b7550e5a32eb42f5fad412ca1ef4df0f2a789a51468d33eb4656c828e
MD5 a604d9f3fe63fe47cccbe8fc90796633
BLAKE2b-256 323a4e0a25f683170e9c2f98c1224b9003f5a5ae281a540d94d6692eda3cd87c

See more details on using hashes here.

File details

Details for the file pypmltracker-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pypmltracker-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for pypmltracker-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f71928aec8a48ac46b4b093295595108d837f3bb81a0feac2ae0be75a059ba24
MD5 0e80ba22e767ab61041f396854d0f867
BLAKE2b-256 09554e34bbf6f673ad7822c10fe801a41cdb6afb0b140be0b9aa1cb0d6e3c6d1

See more details on using hashes here.

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