Skip to main content

The Meeshkan Client for interactive machine learning

Project description

Meeshkan client

Getting started

Sign up at and get your token. Add the folder .meeshkan in your home directory and, inside the folder, add a file named credentials with the following format:



pip install meeshkan

Command-line interface

To list available commands, execute meeshkan or meeshkan help:

Usage: meeshkan [OPTIONS] COMMAND [ARGS]...

  -h, --help  Show this message and exit.
  --version   Show the version and exit.

  clear     Clears Meeshkan log and job directories in ~/.meeshkan.
  help      Show this message and exit.
  list      Lists the job queue and status for each job.
  sorry     Send error logs to Meeshkan HQ.
  start     Starts Meeshkan service daemon.
  status    Checks and returns the service daemon status.
  stop      Stops the service daemon.
  submit    Submits a new job to the service daemon.

Start service daemon

meeshkan start

If you get Unauthorized error, please check your credentials. If the problem persists, please contact Meeshkan support.

Check service status

meeshkan status

You should get the message Service is up and running.

Submit a Python script for execution

Submit the example script for execution:

meeshkan submit [--name job_name] examples/

List submitted jobs

meeshkan list

Stop service

meeshkan stop

Reporting scalars from PyTorch

Get started

Start the service first, then run

meeshkan submit --poll 10 examples/


See examples/ for an example script. To run the script, first ensure that PyTorch is installed in your Python environment. Then submit the example as

meeshkan submit --poll 10 examples/

Meeshkan reports the training and test loss values to you every 10 seconds.



For users:

python install

For developers:

pip install -e .[dev]

Running tests



python test

Running lint

pylint -f msvs meeshkan

Building the documentation

cd docs
sphinx-apidoc -f -e -o source/ ../meeshkan/
make html

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
meeshkan-0.1.0-py2.py3-none-any.whl (29.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3
meeshkan-0.1.0.tar.gz (23.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page