# HG changeset patch # User Pierre-Yves David <pierre-yves.david@octobus.net> # Date 1660779796 -7200 # Thu Aug 18 01:43:16 2022 +0200 # Node ID 3c5fe75653d423f8752237268ba2f9093c8f9825 # Parent 28c8ea877e39158831c2e7f4005c4ef00daaca88 add some documentation about data-vars diff --git a/docs/concept.rst b/docs/concept.rst --- a/docs/concept.rst +++ b/docs/concept.rst @@ -18,6 +18,9 @@ Inside each tarball is a data-env.poulpe file, which specifies the data source, metadata and arguments and transformations needed to setup for a benchmark. +Data environments can define "data variables" who value will be used by the +benchmarks. + Binary Environment ------------------ @@ -30,7 +33,9 @@ Benchmark --------- -A `xxx.pdb` file that describe how to run a specific benchmark and its variant +A `xxx.pdb` file that describe how to run a specific benchmark and its variant. + +The variable from the "data-envs" can be used to configure the benchmark. Running benchmarks ==================