Welcome to Abed’s documentation!¶
This site covers the usage and API documentation of Abed. For information on what Abed is, see the Welcome to Abed! page.
Tutorial¶
The Abed tutorial gives an overview of the basic setup of a new Abed project. It can be found here: Overview and Tutorial.
Usage documentation¶
For a complete overview of how Abed can be used beyond what is covered in the Overview and Tutorial, there is the usage documentation.
- Analyzing Abed’s Output
- Example: Using Abed for comparing regression methods
- Designing Executable Scripts
- Types of Experiments
- Abed’s Features
- Installation and Requirements
- Defining custom metric functions
- The Abed Settings file
- Understanding Statistical Test Results
- Overview and Tutorial
- How Abed works
API documentation¶
For information on the internals of Abed, each function has been documented using docstrings. This results in autogenerated API documentation, which can be found through the following links.
Core functionality:
- Automatic Job Management
- Result Compression
- Configuration Loading
- Constants
- Dataset Utilities
- Exceptions
- Communication through Fabric
- Utilities for working with Fabric
- Working with Git
- Help functionality
- Initialization of Abed
- Running jobs locally
- Main Abed class
- Working with PBS
- Progressbar wrappers
- Master-worker module
- Master-worker utilities
- Managing Tasks
- Command line user interface
- General Utility functions
- Dealing with result archives
Result management:
- Generate result tables for assess mode
- Functions for parsing the result files
- Generate result tables for cv_tt mode
- Functions for exporting tables
- Main entrypoint to generate results
- Class definitions used for parsing results
- Functions for generating Rank Tables
- Testing statistical significance
- Building scalar tables
- Functions for iterating over results
HTML generation: