jayachandrab1606 / codalab-worksheets Goto Github PK

View Code? Open in Web Editor NEW

A collaborative platform for reproducible research (web interface and CLI).

License: Other

Python 66.75% Mako 0.02% Shell 1.09% Batchfile 0.01% CSS 12.26% HTML 0.52% JavaScript 19.03% Vim Script 0.06% Perl 6 0.04% Smarty 0.23%

codalab-worksheets's Introduction

CodaLab Worksheets

The goal of CodaLab Worksheets is to faciliate transparent, reproducible, and collaborative research in computation- and data-intensive areas such as machine learning.

The CodaLab Bundle Service allows users to create bundles, which are immutable directories containing code or data. Bundles are either uploaded or created from other bundles by executing arbitrary commands. When the latter happens, all the provenance information is preserved. In addition, users can create worksheets, which interleave bundles with free-form textual descriptions, allowing one to easily describe an experimental workflow.

The CodaLab frontend holds the React front-end web interface for CodaLab worksheets.

To get started visit the official CodaLab Worksheets instance For more information about the platform, visit our Wiki

If you're interested in contributing or setting up your own CodaLab Worksheets instance, get in touch with us

Bringing up your own instance of CodaLab Worksheets

We provide a convenience script that uses docker-compose to bring up a full fledged CodaLab server in this repo. To get started, make sure you have a recent version of Docker and docker-compose installed. Simply run bash docker/service/start_service.sh -i to bring up a fresh instance of CodaLab with the default configuration. If you've made local changes to the codebase and would like to rebuild docker images from the current state of the codebase, use bash docker/service/start_service.sh -i -b. If you've previously started an instance and thus have the database and root account initialization done, omit the -i flag to just bring the service up like so: bash docker/service/start_service.sh -b

You can customize variables such as the root account credentials, where the bundle store and home folder and mysql data are mounted in your local filesystem. To see a full list of these variables and their names, consult docker/service/start_service.sh.

codalab-worksheets's People