API Documentation

Full API documentation of the lookoutequipment Python package.

Schema

schema.create_data_schema_from_dir(root_dir)

Generates a data schema compatible for Lookout for Equipment from a local directory

schema.create_data_schema_from_s3_path(s3_path)

Generates a data schema compatible for Lookout for Equipment from an S3 directory

schema.create_data_schema(component_fields_map)

Generates a JSON formatted string from a dictionary

Datasets

dataset.list_datasets([dataset_name_prefix, …])

List all the Lookout for Equipment datasets available in this account.

dataset.load_dataset(dataset_name, target_dir)

This function can be used to download example datasets to run Amazon Lookout for Equipment on.

dataset.upload_dataset(root_dir, bucket, prefix)

Upload a local dataset to S3.

dataset.prepare_inference_data(root_dir, …)

This function prepares sequence of data suitable as input for an inference scheduler.

dataset.generate_replay_data(dataset_name, …)

Generates inference input data from the training data to test a scheduler that would be configured for a model trained with this dataset.

dataset.LookoutEquipmentDataset(…[, …])

A class to manage Lookout for Equipment datasets

Models

model.list_models([model_name_prefix, …])

List all the models available in the current account

model.LookoutEquipmentModel(model_name, …)

A class to manage Lookout for Equipment models

Evaluation

evaluation.LookoutEquipmentAnalysis(…)

A class to manage Lookout for Equipment result analysis

Scheduler

scheduler.LookoutEquipmentScheduler(…)

A class to represent a Lookout for Equipment inference scheduler object.

scheduler.LookoutEquipmentSchedulerInspector(…)

A class to be used to inspect existing inference scheduler and output a report about how the inputs should be structured

Plot

plot.plot_histogram_comparison(timeseries_1, …)

Takes two timeseries and plot a histogram showing their respective distribution of values

plot.plot_event_barh(event_details[, …])

Plot a horizontal bar chart with the feature importance of each signal that contributes to the event passed as an argument.

plot.plot_range(range_df, range_title, …)

Plot a range with either labelled or predicted events as a filled area positionned under the timeseries data.

plot.TimeSeriesVisualization(timeseries_df, …)

A class to manage time series visualization along with labels and detected events