results

Full name: ase2sprkkr.asr.core.results

Module class hierarchy

Description

Implements ASRResult object and related quantities.

The most important class in this module is asr.core.results.ASRResult, which is used to wrap results generated with ASR.

asr.core.results.ASRResult has a bunch of associated encoders that implements different ways of representing results, and potentially also implements ways to decode results. These encoders are:

• asr.core.results.DictEncoder

• asr.core.results.JSONEncoder

• asr.core.results.HTMLEncoder

• asr.core.results.WebPanelEncoder

A dictionary representation of a result-object can be converted to a result object through asr.core.results.dct_to_result().

Functions

data_to_dict(dct)	Recursively .todict all result instances.
dct_to_result(dct)	Convert dict representing an ASR result to corresponding result object.
find_class_matching_version(returns, version)	Find result class that matches version.
format_key_description_pair(key, attr_type, ...)	Format a key-type-description for a docstring.
get_key_descriptions(obj)	Get key descriptions of object.
get_object_matching_obj_id(asr_obj_id)
get_object_types(obj)	Get type hints of object.
get_reader_function(dct)	Determine dataformat of dct and return approriate reader.
make_property(key, doc, return_type)
obj_to_id(cls)	Get a string representation of path to object.
object_description_to_object(object_description)	Instantiate object description.
prepare_result(cls)	Prepare result class.
read_hacked_data(dct)	Fix hacked results files to contain necessary metadata.
read_new_data(dct)	Parse a new style result dictionary.
read_old_data(dct)	Parse an old style result dictionary.

Classes

ASRResult([data, metadata, strict])	Base class for describing results generated with recipes.
DictEncoder()	Dict ASRResult encoder.
HTMLEncoder()	HTML ASRResult encoder.
HackedASRResult([data, metadata, strict])
JSONEncoder()	JSON ASRResult encoder.
MetaData(**kwargs)	Metadata object.
ObjectDescription(object_id, args, kwargs[, ...])	Result object descriptor.
ResultEncoder()	Abstract encoder base class.
WebPanelEncoder()	Encoder for ASE compatible webpanels.

Exceptions

MetaDataNotSetError	Error raised when encountering unknown metadata key.
UnknownASRResultFormat	Exception when encountering unknown results version number.
UnknownDataFormat	Unknown ASR Result format.