Skip to main content



Gitter PyPi lgtm

A version control system for software 2.0.


Complete Documentation: stockroom.page


Introduction

Stockroom is a platform to version models, data, parameters, experiment artifacts etc. alongside git versioned source code.

  • It is easy. The APIs are very similar to dictionaries in python
  • It works alongside Git - in case you need to version source code as well. It's OK if you don't.
  • High performance, thanks to the amazing hangar library
  • Integration with PyTorch and it's ecosystem, so that you don't need to write the complex pipeline code.

Why

One important motivation behind the initial design of stockroom is to avoid users learning another tool for versioning. We try to make the APIs as minimal and familiar as possible. Similar to other versioning tools, stockroom let "git" does checkout and rely on "git" to move between branches/commits. But unlike other tools, we channel your data access through the smart API so that we don't need to move the huge data files around when you traverse between commits.

Installation

$ pip install stockroom

Example

from stockroom import StockRoom

stock = StockRoom(write=True)
model.load_state_dict(stock.model['resnet50'])
for e in range(epochs):
    for i in range(limit):
        optimizer.zero_grad()
        x, y = stock.data['dataset_name', i]
        out = model(x)
        loss = criterion(out, y)
        loss.backward()
        optimizer.step()
        if loss < previous_loss:
            stock.experiment['loss'] = loss.item()
            stock.model['resnet50'] = model.state_dict()
            stock.commit('adding a better model')

Contributing

We'd love to have you in the contributors list. Do check out the contributors guide before submitting a PR. Here is our latest #Hall-Of-Fame

License

This project is licensed under the terms of the Apache Software License 2.0

Metadata

Release files for stockroom 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stockroom 0.2.2
File Size Uploaded
stockroom-0.2.2.tar.gz 119.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for stockroom 0.2.2
File Interpreter ABI Platform
stockroom-0.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 136.2 kB

Release files / stockroom-0.2.2.tar.gz

Download URL stockroom-0.2.2.tar.gz
Size 119.1 kB
Tags Source
SHA-256 checksum
How to use checksums
9813fb8f51d1ef7407da4a3c0c8b6193580a0c71db4e3064b1d51e99672acf82
BLAKE2b-256 checksum
How to use checksums
c531e821d831d358d3a33c1b762563eb15892e36e5a0a5c2a583a93b8c0db2b3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.3

Release files / stockroom-0.2.2-py3-none-any.whl

Download URL stockroom-0.2.2-py3-none-any.whl
Size 17.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
169af06a9e51e6305306557ca49bd87cc95ede24ba202dd62f6c85bc680bdcd9
BLAKE2b-256 checksum
How to use checksums
648797ad80ea0189f3fe3f5fcd86de3e7230c8d5a0b372ecd91b5245faa7401b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.3

Release history Release notifications | RSS feed

This release

0.2.2 This release

2 release files

0.2.1

2 release files

0.1.0

1 release file

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page