Skip to main content

A collection of usefull hydra callbacks for hydra configuration

Project description

Hydra Callbacks

style framework codecov CD CI Release

A collection of usefulls callbacks for the https://hydra.cc/ configuration framework.

Installation

pip install hydra-callbacks

Development version

pip install git+https://github.com/paquiteau/hydra-callbacks

Usage

In your hydra root config file add the following:

hydra: 
  # ... 
  callbacks: 
    git_info:
      _target_: hydra_callbacks.GitInfo 
      clean: true
    latest_link:
      _target_: hydra_callbacks.LatestRunLink

Available Callbacks

Name Action
GitInfo Check status of Repository
LatestRunLink Get a link to the latest run
MultiRunGatherer Gather results json file in a single table
RuntimePerformance Get Execution time for each run

And more to come !

Also Available

  • PerfLogger : A simple to use performance logger
  
from hydra_callbacks import PerfLogger 
import logging

log = logging.getLogger(__name__)
def main_app(cfg):
    with PerfLogger(log, "step1"):
        sleep(1)

    with PerfLogger(log, "step2"):
        sleep(2)
    log.info(PerfLogger.recap())

You too, have cool Callbacks, or idea for one ?

Open a PR or an issue !

Possible Ideas

  • [In progress] A Ressource Monitoring Callback
  • A callback that summarize log from multiple runs

Project details


Download files

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

Source Distribution

hydra-callbacks-0.2.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

hydra_callbacks-0.2.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file hydra-callbacks-0.2.0.tar.gz.

File metadata

  • Download URL: hydra-callbacks-0.2.0.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for hydra-callbacks-0.2.0.tar.gz
Algorithm Hash digest
SHA256 39b01677a142f12e77413ba71a49fc12b2fc7a8bbf0d73fffc716c8e142e304e
MD5 69fd9bfd171d966fdc85e5a923046fb0
BLAKE2b-256 8ae39d970aa7dc67bd05f51c45952ca351cb145e1f40623c1c4269eaf886ac28

See more details on using hashes here.

File details

Details for the file hydra_callbacks-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hydra_callbacks-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e073701dbcb55248e16fae940600e2bbe7db3b590576d850744760e9cf7906da
MD5 a647817b5c770ae56ee37e26408f0b64
BLAKE2b-256 c432ffdb6f1694a29873d84aecaeeb5e0b694803c0e1f7c87dd7181ddf596927

See more details on using hashes here.

Supported by

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