app / README.md
tristan-deep's picture
Add presets.yaml from tue-bmd/zea (zea-app-robustness) and explain the sync
25b8f07 verified
|
Raw History Blame Contribute Delete
1.51 kB
metadata
license: apache-2.0
pretty_name: zea app

zea app

Files used by the zea dataset visualizer (zea app).

File Purpose Source in tue-bmd/zea
presets.yaml Example presets in the app's preset dropdown zea/data/app_presets.yaml

How presets are updated

  1. Open a pull request on tue-bmd/zea that edits zea/data/app_presets.yaml. The field reference is at the top of that file.
  2. On merge, the sync-hf.yaml workflow uploads it here, to the main branch.
  3. Every installed zea version downloads presets.yaml from main when the app starts, so the change reaches all users without a zea release. Presets that need a newer zea set min_zea_version and are hidden in older versions.

Please don't edit files here directly: the next sync overwrites them.

Branches

  • main: the latest presets, read by the app by default.
  • vX.Y.Z: a snapshot made at each zea release, for reproducibility.

To load another revision, or a local file:

zea app --presets-revision v0.1.8      # a release snapshot
zea app --presets-revision refs/pr/1   # preview a pull request on this repo
zea app --presets path/to/presets.yaml # a local file

If the hub can't be reached, the app uses the presets bundled with the installed zea.