Skip to main content

A simple record toolkit generating human readable data record for experiment

Project description

record-kit

A simple record toolkit for experiment.

Installation

pip install record-kit

Usage

experiment.py

from record_kit import Recorder                      # use Recorder to track experiment data
import argparse


parser = argparse.ArgumentParser()
parser.add_argument('--lr', type=float)
args = parser.parse_args()

recorder = Recorder()                                # init Recorder
recorder.write_meta(args)                            # save arguments like hyperparameters
recorder.write_header('epoch', 'loss', 'acc')        # specify table header
recorder.write_data_line(0, 0.1, 0.5)                # save data
recorder.write_data_line(1, 0.08, 0.9)

generated record in ./records/record-timestamp.md

record_example

API

Recorder(file_name='record', records_dir='./records', with_timestamp=True)

Initialize a Recorder instance

Recorder.write_meta(dict_like_object)

####Recorder.write_header(*args) ####Recorder.write_data_line(*args)

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

record-kit-0.1.4.tar.gz (3.1 kB view hashes)

Uploaded Source

Built Distribution

record_kit-0.1.4-py3-none-any.whl (4.6 kB view hashes)

Uploaded Python 3

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