Skip to main content

A minimal dataset versioning system for text data with a focus on reproducibility.

Project description

Marco Dataset Versioning System

A minimal dataset versioning system for text data with a strong focus on reproducibility and transparency. Treat your text datasets like code — immutable, versioned, reproducible, and explainable.

Marco acts as a lightweight Python library, meaning you can initialize it in any machine learning project folder to safely version and preprocess your datasets without altering your original files.

🚀 Installation (Linux / MacOS)

On modern Linux environments (like Arch Linux, Ubuntu 23.04+), Python packages must be installed in a Virtual Environment (PEP 668) to prevent conflicts with your system packages.

Follow these steps to safely install Marco into your ML project:

  1. Clone this repository to your local machine:

    git clone https://github.com/your-username/marco.git
    cd marco
    
  2. Navigate to the ML project folder where you want to train your model (e.g. your bag-of-words project):

    cd ~/projects/my-bag-of-words-model
    
  3. Create and activate a Python Virtual Environment:

    # Create a virtual environment named 'venv'
    python3 -m venv venv
    
    # Activate it (You must do this every time you open a new terminal in this folder)
    source venv/bin/activate
    

    (You should now see (venv) at the start of your terminal prompt!)

  4. Install Marco:

    # Point pip to the directory where you cloned the marco repository
    pip install -e /path/to/marco
    

🛠️ Usage Guide

Once marco is installed in your virtual environment, you have access to the full CLI!

1. Initialize a Repository

Initialize Marco tracking in your current directory. This creates a .marco/ data versioning environment specific to that project.

marco init

2. Create an Immutable Version

Upload a text/CSV/TSV dataset to create an immutable version. Marco will compute a cryptographically secure SHA-256 hash using the raw data + the preprocessing configuration.

Interactive Mode: If you don't supply a configuration file, Marco will interactively guide you through building the preprocessing pipeline (Lowercasing, Tokenization, Stopwords Removal, Deduplicating).

marco upload my_dataset.csv -t v1-raw

Config Mode:

marco upload my_dataset.csv -c my_config.json -t v1-processed

3. List Versions

View all the versions you've created, along with their tags and timestamps.

marco list

4. Restore/Checkout Data

Extract the processed dataset from marco's storage back into your active workspace to use for model training.

marco restore v1-processed -o ./training_data.tsv

5. Start the Visual Dashboard

Open the Flask-powered web dashboard or the new React DAG visualizer to view dataset metadata, differences between versions, and complete data lineage trees.

Start the React DAG Comparison Dashboard (New):

marco generate-web

(This will automatically open your browser to http://localhost:7654 and load your local .marco graphs).

Start the legacy HTML Dashboard:

python -m marco.web.app --port 5000

6. Export / Import Versions

Easily share dataset versions with teammates by packing them into .tar.gz files.

# Export version 'v1-raw' to the 'exports' folder
marco export v1-raw ./exports/

# Import an archive sent to you by a coworker
marco import ./exports/marco_version_e5e0b767.tar.gz

🧠 Architecture Overview

Marco decouples logic from the file system. All core engine operations sit inside marco/core/, including:

  • locker.py: File-based concurrency control using .lock files.
  • repository.py: CRUD operations for dataset versions and refs.json tagging.
  • preprocessor.py: A robust Directed Acyclic Graph (DAG) preprocessing engine.

Have fun building safer machine learning pipelines!

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

marco_dvcs-0.1.4.tar.gz (280.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

marco_dvcs-0.1.4-py3-none-any.whl (284.6 kB view details)

Uploaded Python 3

File details

Details for the file marco_dvcs-0.1.4.tar.gz.

File metadata

  • Download URL: marco_dvcs-0.1.4.tar.gz
  • Upload date:
  • Size: 280.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for marco_dvcs-0.1.4.tar.gz
Algorithm Hash digest
SHA256 008001f1d61d4edeedb7d75b83d78856ccab76c352f2bfa75a6b3e06ee56315e
MD5 73b2975e6a10d0aa5252a04550eb3eb7
BLAKE2b-256 9737b5949b3c4683133a5ee1cc3f1577440100c7eb36384a17275201df204681

See more details on using hashes here.

File details

Details for the file marco_dvcs-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: marco_dvcs-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 284.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for marco_dvcs-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4b1ed95991d5d5ee0c353f6967ef47c0e36771fe857b071892e6dd3e0983014c
MD5 385ca180dc1ee44d4e5ccc6ab1087e1e
BLAKE2b-256 a86209d48ea37512d6798ab9182d361b906a732c8b9ec7c8c6dfcb5d206e2918

See more details on using hashes here.

Supported by

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