Keep track of your machine learning experiments.
ScalarStop is an open-source framework for reproducible machine learning research.
ScalarStop was written and open-sourced at Neocrym, where it is used to train thousands of models every week.
ScalarStop can help you:
organize datasets and models with content-addressable names.
ScalarStop datasets and models are given automatically-generated
names based on their hyperparameters--making them easy to version and easy to find.
save/load datasets and models to/from the filesystem.
ScalarStop wraps existing dataset and model saving logic in TensorFlow
for safety, correctness, and completion.
record hyperparameters and metrics to a relational database.
ScalarStop saves dataset and model names, hyperparameters, and training
metrics to a SQLite or PostgreSQL database.
Getting started¶
System requirements¶
ScalarStop is a Python package that requires Python 3.8 or newer.
Currently, ScalarStop only supports tracking tf.data.Dataset
datasets and tf.keras.Model models. As such, ScalarStop
requires TensorFlow 2.8.0 or newer.
We encourage anybody that would like to add support for other
machine learning frameworks to ScalarStop. :)
Installation¶
ScalarStop is available on PyPI.
If you are using TensorFlow on a CPU, you can install ScalarStop with the command:
python3 -m pip install scalarstop[tensorflow]
If you are using TensorFlow with GPUs, you can install ScalarStop with the command:
python3 -m pip install scalarstop[tensorflow-gpu]
Development¶
If you would like to make changes to ScalarStop, you can clone the repository
from GitHub.
git clone https://github.com/scalarstop/scalarstop.git
cd scalarstop
python3 -m pip install .
Usage¶
The best way to learn ScalarStop is to follow the
Official ScalarStop Tutorial.
Afterwards, you might want to dig deeper into the ScalarStop documentation.
In general, a typical ScalarStop workflow involves four steps:
Organize your datasets with scalarstop.datablob.
Describe your machine learning model architectures using scalarstop.model_template.
Load, train, and save machine learning models with scalarstop.model.
Save hyperparameters and training metrics to a SQLite or PostgreSQL database using scalarstop.train_store.
Getting started¶
System requirements¶
ScalarStop is a Python package that requires Python 3.8 or newer.
Currently, ScalarStop only supports tracking tf.data.Dataset
datasets and tf.keras.Model models. As such, ScalarStop
requires TensorFlow 2.8.0 or newer.
We encourage anybody that would like to add support for other machine learning frameworks to ScalarStop. :)
Installation¶
ScalarStop is available on PyPI.
If you are using TensorFlow on a CPU, you can install ScalarStop with the command:
python3 -m pip install scalarstop[tensorflow]
If you are using TensorFlow with GPUs, you can install ScalarStop with the command:
python3 -m pip install scalarstop[tensorflow-gpu]
Development¶
If you would like to make changes to ScalarStop, you can clone the repository from GitHub.
git clone https://github.com/scalarstop/scalarstop.git
cd scalarstop
python3 -m pip install .
Usage¶
The best way to learn ScalarStop is to follow the Official ScalarStop Tutorial.
Afterwards, you might want to dig deeper into the ScalarStop documentation. In general, a typical ScalarStop workflow involves four steps:
Organize your datasets with
scalarstop.datablob.Describe your machine learning model architectures using
scalarstop.model_template.Load, train, and save machine learning models with
scalarstop.model.Save hyperparameters and training metrics to a SQLite or PostgreSQL database using
scalarstop.train_store.