Skip to main content

Features

mthd turns your commit history into a searchable scientific log.

Every time you run an experiment, your code will be auto-committed with metadata in the commit message.

Installation

  • uv add mthd

Usage

  • Put the @commit decorator on your experiment function.
  • mthd will store hyperparameters and metrics as metadata in the commit message.
  • Query your scientific log, e.g. mthd query metrics.accuracy < 0.8.
from mthd import commit, Run

@commit
def my_experiment(run: Run) -> Metrics:
    ...

    run.set_hyperparameters({
        "lr": 0.001,
        "epochs": 100,
    })

    ...

    run.set_metrics({
        "accuracy": 0.9,
    })

if __name__ == "__main__":
    my_experiment()

Then run your experiment:

$ python experiment.py

Generating commit with message:

    exp: run my_experiment at 2025-02-10 18:39:18.759230

    ---

    {
      "experiment": "my_experiment",
      "hyperparameters": {
        "lr": 0.001,
        "epochs": 100,
      },
      "metrics": {
        "accuracy": 0.9,
      },
      "uuid": "94871de1-4d6c-4e70-9c9d-60ec11df1159",
      "artifacts": null,
      "annotations": null,
      "timestamp": "2025-02-10T18:39:18.759230"
    }

Finally, query for relevant commits:

$ mthd query metrics.accuracy > 0.8

Found 1 commit(s):

    af6cd7

Development

  • git clone https://github.com/flywhl/mthd.git
  • cd mthd
  • uv sync
  • just test

Flywheel

Science needs better software tools. Flywheel is an open source collective building simple tools to preserve scientific momentum, inspired by devtools and devops culture. Join our Discord here.

Metadata

Release files for mthd 0.2.1

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

Source distribution (sdist)

Source distribution for mthd 0.2.1
File Size Uploaded Provenance Actions
mthd-0.2.1.tar.gz 47.5 kB Without provenance Details for mthd-0.2.1.tar.gz

Built distribution (wheel)

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

Total release size: 60.8 kB

Release files / mthd-0.2.1.tar.gz

Download URL mthd-0.2.1.tar.gz
Size 47.5 kB
Tags Source
SHA-256 checksum
How to use checksums
8935e9f421f33372a540c5cd59f4c6ee3e776507103ceec6e0592cd8f9c534e2
BLAKE2b-256 checksum
How to use checksums
e29e70eb6811d10df276b784c965e4946acdfe72cf9c1ca177cccfea76f77909
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.6.0

Release files / mthd-0.2.1-py3-none-any.whl

Download URL mthd-0.2.1-py3-none-any.whl
Size 13.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b6e60f2e767210d4169efa4a14f034140e1d9e79472695ae3bd6f127bb55ddd6
BLAKE2b-256 checksum
How to use checksums
1af48c13269a16bf249161df4bb4d55652afeb8785780cf73bd672daab852395
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.6.0

Security for mthd 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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