diff --git a/code-postprocessing/README.md b/code-postprocessing/README.md index 14d399829..15ab73578 100644 --- a/code-postprocessing/README.md +++ b/code-postprocessing/README.md @@ -1,6 +1,6 @@ # COmparing Continuous Optimisers (COCO) post-processing -The ([`cocopp`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.html)) package takes data generated with the [COCO framework](https://github.com/numbbo/coco) to compare continuous opitmizers and produces output figures and tables in html format and for including into LaTeX-documents. +The ([`cocopp`](https://numbbo.github.io/gforge/apidocs-cocopp/cocopp.html)) package takes data generated with the [COCO framework](https://github.com/numbbo/coco) to compare continuous opitmizers and produces output figures and tables in html format and for including into LaTeX-documents. ## Installation @@ -8,20 +8,12 @@ The ([`cocopp`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.html)) packag ## Usage -The [`cocopp.Interface`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.Interface.html) class contains the most basic commands and data of the package, sufficient for most use cases. - -
>>> import cocopp ->>> sorted(cocopp.Interface.dir()) -['archives', 'config', 'genericsettings', 'load', 'main'] ->>> all(hasattr(cocopp, name) for name in cocopp.Interface.dir()) -True- -The main method of the [`cocopp`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.html) package is [`main`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.rungeneric.html#main) (currently aliased to [`cocopp.rungeneric.main`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.rungeneric.html#main)). The [`main`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.rungeneric.html#main) method also allows basic use of the post-processing through a shell command-line interface. The recommended use is however from an IPython/Jupyter shell or notebook: +The main method of the [`cocopp`](https://numbbo.github.io/gforge/apidocs-cocopp/cocopp.html) package is [`main`](https://numbbo.github.io/gforge/apidocs-cocopp/cocopp.rungeneric.html#main) (currently aliased to [`cocopp.rungeneric.main`](https://numbbo.github.io/gforge/apidocs-cocopp/cocopp.rungeneric.html#main)). The [`main`](https://numbbo.github.io/gforge/apidocs-cocopp/cocopp.rungeneric.html#main) method also allows basic use of the post-processing through a shell command-line interface. The recommended use is however from an IPython/Jupyter shell or notebook:
>>> import cocopp >>> cocopp.main('exdata/my_output another_folder yet_another_or_not')-postprocesses data from one or several folders, for example data generated with the help from the [`cocoex`](https://coco.gforge.inria.fr/apidocs-cocoex) module. Each folder should contain data of a full experiment with a single algorithm. (Within the folder the data can be distributed over subfolders). Results can be explored from the ppdata/index.html file, unless a a different output folder is specified with the -o option. **Comparative data** from over 200 full experiments are archived online and can be listed, filtered, and retrieved from [`cocopp.archives`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.archives.html) (of type [`OfficialArchives`](https://coco.gforge.inria.fr/apidocs-cocopp/cocopp.archiving.OfficialArchives.html)) and processed alone or together with local data. For example +postprocesses data from one or several folders, for example data generated with the help from the [`cocoex`](https://numbbo.github.io/gforge/apidocs-cocoex) module. Each folder should contain data of a full experiment with a single algorithm. (Within the folder the data can be distributed over subfolders). Results can be explored from the ppdata/index.html file, unless a a different output folder is specified with the -o option. **Comparative data** from over 200 full experiments are archived online and can be listed, filtered, and retrieved from [`cocopp.archives`](https://numbbo.github.io/gforge/apidocs-cocopp/cocopp.archives.html) (of type [`OfficialArchives`](https://numbbo.github.io/gforge/apidocs-cocopp/cocopp.archiving.OfficialArchives.html)) and processed alone or together with local data. For example
>>> cocopp.archives.bbob('bfgs') ['2009/BFGS_...@@ -38,7 +30,7 @@ Only a trailing `*` is accepted and any string containing the substring is match
>>> cocopp.main('bbob/2009/*')-can be browsed at [http://coco.gforge.inria.fr/ppdata-archive/bbob/2009-all](http://coco.gforge.inria.fr/ppdata-archive/bbob/2009-all). To display algorithms in the background, the genericsettings.background variable needs to be set: +can be browsed at [https://numbbo.github.io/ppdata-archive/bbob/2009-all](https://numbbo.github.io/ppdata-archive/bbob/2009-all). To display algorithms in the background, the genericsettings.background variable needs to be set:
>>> cocopp.genericsettings.background = {None: cocopp.archives.bbob.get_all('bfgs')}