Skip to main content

Valohai.yaml validation and parsing

Project description

valohai-yaml

Build Status Codecov License: MIT

Parses and validates valohai.yaml files.

Valohai YAML files are used to define how your machine learning project workloads and pipelines are ran on the Valohai ecosystem. Refer to Valohai Documentation to learn how to write the actual YAML files and for more in-depth usage examples.

Installation

pip install valohai-yaml

Usage

Validation

Programmatic usage:

from valohai_yaml import validate, ValidationErrors

try:
    with open('path/to/valohai.yaml') as f:
        validate(f)
except ValidationErrors as errors:
    print('oh no!')
    for err in errors:
        print(err)

Command-line usage:

valohai-yaml my_yaml.yaml
echo $?  # 1 if errors, 0 if ok

Parsing

from valohai_yaml import parse

with open('path/to/valohai.yaml') as f:
    config = parse(f)

print(config.steps['cool step'].command)

Development

# setup development dependencies
pip install -e . -r requirements-test.txt pre-commit
pre-commit install

# run linting and type checks
pre-commit run --all-files

# run tests
pytest

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

valohai_yaml-0.29.0.tar.gz (40.1 kB view details)

Uploaded Source

Built Distribution

valohai_yaml-0.29.0-py3-none-any.whl (46.5 kB view details)

Uploaded Python 3

File details

Details for the file valohai_yaml-0.29.0.tar.gz.

File metadata

  • Download URL: valohai_yaml-0.29.0.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for valohai_yaml-0.29.0.tar.gz
Algorithm Hash digest
SHA256 8f727caeaed1ab1100a89c7a07056b1a6a4dc2f839c838d230b6803f483d1d45
MD5 8d5f3a3414d8d86ee36af286551af080
BLAKE2b-256 dc0be67e5450d9cc51975a4298231ce3de47e1e7a2d63f37cdc868ce2651ff32

See more details on using hashes here.

Provenance

File details

Details for the file valohai_yaml-0.29.0-py3-none-any.whl.

File metadata

File hashes

Hashes for valohai_yaml-0.29.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a897951c7e2720b0320c327abf50f673b70fb0741f521f05eb9af1f9547844f
MD5 934cfa1fe18b9e74b6c06756afe22fa0
BLAKE2b-256 2b012688574a25ca7e4d5bd3c154db6eafce7639d3f86df681b0aae5b910b011

See more details on using hashes here.

Provenance

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