RAI.Analysis

Submodules

RAI.Analysis.analysis module

class RAI.Analysis.analysis.Analysis(ai_system: AISystem, dataset: str, tag: str | None = None)[source]

Bases: ABC

abstract initialize()[source]
classmethod is_compatible(ai_system, dataset: str)[source]
Parameters:
  • ai_system – input the ai_system object

  • dataset – input the dataset

Returns:

class object

Returns the classifier and sklearn object data

progress_percent(percentage_complete)[source]
Parameter:

percentage_complete

Returns:

None

Shows the progress percent value

progress_tick()[source]
Parameter:

None

Returns:

None

On every compute it changes the current_tick value

set_connection(connection)[source]
Parameters:

connection – inputs connection data

Returns:

None

Connection is a function that accepts progress, and pings the dashboard

abstract to_html()[source]
abstract to_string()[source]

RAI.Analysis.analysis_manager module

class RAI.Analysis.analysis_manager.AnalysisManager[source]

Bases: object

get_available_analysis(ai_system: AISystem, dataset: str)[source]
Parameters:
  • AISystem – input the ai_system obj

  • dataset – input the dataset

Returns:

list.

Returns the lists of analysis data

run_all(ai_system: AISystem, dataset: str, tag: str)[source]
Parameters:
  • AISystem – input the ai_system obj

  • dataset – input the dataset

  • tag – By default None else given tag Name

Returns:

None.

Returns the analysis data result analysis

run_analysis(ai_system: AISystem, dataset: str, analysis_names, tag=None, connection=None)[source]
Parameters:
  • AISystem – input the ai_system obj

  • dataset – input the dataset

  • tag – By default None else given tag Name

  • analysis_names – analysis_names data set

  • connection – By default None

Returns:

Dict.

Returns the analysis data result analysis

RAI.Analysis.analysis_registry module

RAI.Analysis.analysis_registry.register_class(class_name, class_object)[source]
Parameters:
  • class_name – inputs the name for the class and that should be unique

  • class_object – class object is given as the input

Returns:

registered data in the form of dictionary containing class name as the key and class object as the value