Skip to main content

Simple helper for reproducible (research) experiments.

Project description

Move-carrots

Simple helper for reproducible (research) experiments.

Goals

This package aims to make one's life easier with machine learning experiments. To achieve this goal, this package basically does the following two things.

1. Run experiments with some config files.

  • No need for long commands.
  • Reliable and elegant than notebooks.

2. Built-in support to record, view, and reproduce your experiments.

:P)

Quick start

WIP.

Core features

  1. Define your experiment in a human friendly YAML file: main function, parameters, data files, logging, etc.
  2. Codes will be automatically checked in to git with proper tags. Datas will be also version-controlled in a proper manner.
  3. Each experiment will be dumped into a database, including the config, the logging, and the versions of code and data.

Design

Config file

The config file includes:

  • PYTHONPATH
  • main function and parameters
  • misc
    • experiment name
    • logging

Version control

The goal is to re-run one experiment within one command. To achieve this, we will have both codes and data versioned in a proper way.

Codes All local changes, if there are any, will be committed into Git before a config runs. Commits information will be stored in log files and the head commit will be tagged as f"{name}@{time}" for future reference.

Data Data will be stored in the database, which will be keyed by name and md5 value.

Database

The database has two parts: experiment logging and version control.

  1. Experiment logging shows what experiments have been conducted, what's the input/output of one experiment. Based on it, more analysis can be elaborated.
  2. Version control is responsible for recording all versions of codes (through Git) and data (local storage).

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

move-carrots-0.1.1.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

move_carrots-0.1.1-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file move-carrots-0.1.1.tar.gz.

File metadata

File hashes

Hashes for move-carrots-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8846e48ae9524192293b3a348922aa90f732d36b12c5748fa8b45854c9ef550f
MD5 e6ee0d74f5a3535162700441a782d4b6
BLAKE2b-256 9a51afebd8b352feda56ab4a0cbf3b10808751e828ebc43f5b8836a598aa109a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for move_carrots-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 879bf471522bf2935687e2814025e8bec4b8e8d316f72b867999c6d9c9c7cd62
MD5 10d61c0450cc676086a5a000b5846d4e
BLAKE2b-256 8e7c11807caf018ce1eb5b93818284173ab83c7dd2ab6550e80dac1b48333212

See more details on using hashes here.

Provenance

Supported by

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