Python Backend for BEAT¶
In order to run an experiment in BEAT, the user provides the description of data formats, algorithms, data flows (also known as toolchains) and experimental details (parameters) and BEAT schedules and runs the provided recipe to produce displayable result. The algorithms can be written in Python or C++.
This package defines a backend to execute algorithms written in the Python programming language.
- Object Representation
- API
- loader
load_module()
run()
- hash
toPath()
toUserPath()
hash()
hashJSON()
hashJSONFile()
hashFileContents()
hashDataset()
- baseformat
setup_scalar()
setup_array()
pack_array()
pack_scalar()
read_some()
read_string()
unpack_array()
unpack_scalar()
baseformat
- dataformat
Storage
DataFormat
DataFormat.storage
DataFormat.errors
DataFormat.data
DataFormat.resolved
DataFormat.referenced
DataFormat.parent
DataFormat.name
DataFormat.schema_version
DataFormat.extends
DataFormat.type
DataFormat.valid
DataFormat.description
DataFormat.documentation
DataFormat.hash()
DataFormat.validate()
DataFormat.isparent()
DataFormat.json_dumps()
DataFormat.write()
DataFormat.export()
- algorithm
Storage
Runner
Algorithm
Algorithm.dataformats
Algorithm.libraries
Algorithm.input_map
Algorithm.output_map
Algorithm.groups
Algorithm.errors
Algorithm.data
Algorithm.code
Algorithm.LEGACY
Algorithm.SEQUENTIAL
Algorithm.AUTONOMOUS
Algorithm.SEQUENTIAL_LOOP_EVALUATOR
Algorithm.AUTONOMOUS_LOOP_EVALUATOR
Algorithm.SEQUENTIAL_LOOP_PROCESSOR
Algorithm.AUTONOMOUS_LOOP_PROCESSOR
Algorithm.dataformat_klass
Algorithm.name
Algorithm.schema_version
Algorithm.api_version
Algorithm.type
Algorithm.is_autonomous
Algorithm.is_sequential
Algorithm.is_loop
Algorithm.language
Algorithm.clean_parameter()
Algorithm.valid
Algorithm.uses
Algorithm.isAnalyzer
Algorithm.results
Algorithm.parameters
Algorithm.splittable
Algorithm.description
Algorithm.documentation
Algorithm.hash()
Algorithm.result_dataformat()
Algorithm.uses_dict()
Algorithm.runner()
Algorithm.json_dumps()
Algorithm.write()
Algorithm.export()
- database
Storage
Runner
Database
Database.data
Database.name
Database.description
Database.documentation
Database.hash()
Database.schema_version
Database.valid
Database.environment
Database.protocols
Database.protocol()
Database.protocol_names
Database.sets()
Database.set()
Database.set_names()
Database.view_definition()
Database.view()
Database.json_dumps()
Database.write()
Database.export()
View
DatabaseTester
- data
mixDataIndices()
getAllFilenames()
DataSource
FileInfos
CachedDataSource
DatabaseOutputDataSource
RemoteDataSource
DataSink
StdoutDataSink
CachedDataSink
load_data_index()
load_data_index_db()
foundSplitRanges()
- data_loaders
DataView
DataLoader
DataLoaderList
- Database execution
DBExecutor
- Algorithm executor
AlgorithmExecutor
- executor
LoopChannel
LoopExecutor
- Message handlers
MessageHandler
LoopMessageHandler
- helpers
parse_inputs()
parse_outputs()
convert_loop_to_container()
convert_experiment_configuration_to_container()
AccessMode
create_inputs_from_configuration()
create_outputs_from_configuration()
- inputs
first()
Input
InputGroup
InputList
- library
Storage
Library
Library.storage
Library.libraries
Library.errors
Library.data
Library.code
Library.uses_dict()
Library.load()
Library.name
Library.schema_version
Library.language
Library.valid
Library.uses
Library.description
Library.documentation
Library.hash()
Library.json_dumps()
Library.write()
Library.export()
- outputs
SynchronizationListener
Output
RemotelySyncedOutput
OutputList
- stats
io_statistics()
update()
- utils
hashed_or_simple()
safe_rmfile()
safe_rmdir()
extension_for_language()
Prefix
File
AbstractStorage
Storage
CodeStorage
NumpyJSONEncoder
error_on_duplicate_key_hook()
has_argument()