mlm_insights.config_reader package

Subpackages

• mlm_insights.config_reader.exceptions package
  • Submodules
  • mlm_insights.config_reader.exceptions.config_reader_exception module
    • ConfigReaderException
• mlm_insights.config_reader.utils package
  • Submodules
  • mlm_insights.config_reader.utils.config_parser module
    • ConfigParser
      • ConfigParser.compute_params()
      • ConfigParser.get_typed_object()
  • mlm_insights.config_reader.utils.config_reader_utils module
    • generate_input_schema()
    • get_config_dict()
    • get_config_json()
    • get_data_set_metrics()
    • get_engine_detail()
    • get_metric_confing()
    • get_post_processors()
    • get_reader()
    • get_tags()
    • get_transformers()
    • get_univariate_metrics()
    • parse_object_storage_url()
    • read_file()
    • set_custom_component()
    • validate_config_format()
  • mlm_insights.config_reader.utils.config_registry module
    • ConfigRegistry
      • ConfigRegistry.add_dask_components()
      • ConfigRegistry.get_config_map()
      • ConfigRegistry.update_config_map()

Submodules

mlm_insights.config_reader.custom_component module

class mlm_insights.config_reader.custom_component.CustomComponent(component_name: str, component: Any)

Bases: object

mlm_insights.config_reader.insights_config_reader module

class mlm_insights.config_reader.insights_config_reader.InsightsConfigReader(config_location: str, **storage_options: Any)

Bases: object

Config reader class for MLInsights Library. This will be used to build a InsightsBuilder class instance using a config file.

classmethod create_exception_message(test_config_errors: List[str]) → str

get_builder() → InsightsBuilder

Method to create builder components using the config and return the InsightsBuilder object and validate if required parameters are provided to create a InsightsBuilder object.

Returns

InsightsBuilder

An Instance of InsightsBuilder.

get_test_builder(test_context: TestContext) → InsightsTestBuilder

with_custom_component(custom_components: List[CustomComponent]) → InsightsConfigReader

Method to register custom component to be used in config file.

Parameters

custom_componentsList[CustomComponent]

List of custom component to be registered.

Returns

InsightsConfigReader

An Instance of InsightsConfigReader.