Models

Documentation to interact with Models within a Project.

expai.ExpaiProject.create_model

Create a new model within the project.

expai.ExpaiProject.create_model(self, model_path: str = None, model_name: str = None, model_summary: str = None, model_library: str = None, model_objective: str = None, model_prediction_type: str = None, output_classes: list = None, model_cutoff: float = None)

Attribute	Description	Required
model_path	Local path where your model binary file is stored	True
model_name	Name for the model	True
model_summary	Description for the model object	False
model_library	Library used to stored the model binary file	True
model_objective	Objective of the model (regression or classification)	True
model_prediction_type	Type of classification (regression, binary or categorical)	True
output_classes	Alias for the output classes of your classification model. Order names by increasing output of the model. Imagine your model outputs 0 for 'Class A' and 1 for 'Class B', then the value for output_classes would be ['Class A', 'Class B']	False
model_cutoff	Custom decision boundary for your binary classification. By default 0.5 will be considered.	False

my_project.create_model(model_path = os.path.abspath("../../fairness_pipeline.pkl"), 
                     model_name="Potential model",
                     model_summary="Annual revenue over 100K$ model", 
                     model_library = 'pickle', 
                     model_objective = 'classification',
                     model_prediction_type = "binary",
                     output_classes = ["No", "Sí"])

expai.ExpaiProject.model_list

List all models available in the selected project

expai.ExpaiProject.model_list(self, search_by: str = None, exact_search: str = None)

Attribute	Description	Required
search_by	Return only models containing this substring in title	False
exact_search	Return only the model matching exactly this title	False

my_project.model_list()

expai.ExpaiProject.delete_model

Delete a model from the project

You won't be able to revert this action and all users will lose access to the project.

expai.ExpaiProject.delete_model(self, model_name: str = None, model_id: str = None)

Attribute	Description	Required
model_name	Exact name of the model to be deleted.	Yes, if model_id is not provided
model_id	Unique identifier of the model to be deleted.	Yes, if model_name is not provided

expai_account.delete_model(project_name="EXPAI Docs")

expai.ExpaiAccount.update_model

Update model metadata. Fields to be updated and their keys can be found here.

expai.ExpaiProject.update_model(self, model_name: str = None, model_id: str = None, update_info: dict = None)

Attribute	Description	Required
model_name	Exact name of the model to be updated.	Yes, if model_id is not provided
model_id	Unique identifier of the model to be updated.	Yes, if model_name is not provided
update_info	Dictionary containing information to be updated in the model.	Yes

expai_account.update_model(model_name="Potential model",
                           update_info={"model_description_des":"New description"})