Skip to content
Snippets Groups Projects
Commit 380e4457 authored by Pierre-Yves David's avatar Pierre-Yves David :octopus:
Browse files

Add a basic doc file

If it currently very basic be should create a base to extend in the future.
parent 9523c56c
No related branches found
No related tags found
1 merge request!4more doc and utils
Pipeline #56123 passed
===================================================
General Concepts for Poulpe Performance tools Suite
===================================================
General philosophy
==================
(and far too many other stuff as we have a single doc files for now)
Building blocks
===============
Data Environment
----------------
Data environment are directory that contains data to be used in a benchmark.
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.
Binary Environment
------------------
A directory containing a bin-env.poulpe file that describe the binary
environment and a `bin-env.shell` to provide us with a shell within that binary
environment.
Currently we use `mercurial.poulpe-setup.sh` to setup new bin-env.shell.
Benchmark
---------
A `xxx.pdb` file that describe how to run a specific benchmark and its variant
Running benchmarks
==================
Individual Runs
---------------
Each benchmark can be run individually. This give a use more flexibility to run
comparative run, schedule runs and debug faulty ones.
This is done through the `run-util` executable
Results
-------
Each results can be manipulated and compared individually.
They can exists as `xxx.pbr` files. Having option to group them (for example) in
a database will be necessary for scaling
Scheduling
----------
Scheduling is currently minimal and will need further improvement in the futur.
The scheduling install new bin-envs and cleans up older one.
New case are autogenerated using the `auto-cases` executable and the overall logic lives in
`loop` executable. the `upload` is done using the `upload` executable.
Using results
=============
Viewing
-------
The `env-desc` executable can be used to see the content of a `xxx.pbr` files.
Comparing
---------`
The `env-desc` executable can be used to see the content of a `xxx.pbr` files.
Searching
---------
There are no easy way to search result just yet
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment