Login and manage account

In this section, we present ExpaiLogin module and its methods.

expai.ExpaiAccount

Class definition

expai.ExpaiLogin(email: str, user_pass: str, access_token: str = None, server_name: str = "https://api.expai.io")

Attribute	Description	Required
email	Email address for your EXPAI account	True
user_pass	Password for your EXPAI account	True
access_token	Provide an active JWT token for your account	False
server_name	IP address for your EXPAI service. By default, our cloud service will be chosen.	False

Python example to initialise the class

from expai import ExpaiAccount

email = 'YOUR EMAIL HERE'
user_pass = 'YOUR PASS HERE'
expai_account = ExpaiAccount(email=email, user_pass=user_pass)

One account can be only used simultaneously in one device.

expai.ExpaiAccount.create_project

Create a new project in your account

ExpaiAccount.create_project(self, project_name: str = None, project_description: str = None)

Attribute	Description	Required
project_name	Name for your project	True
project_description	Description for your project	False

expai_account.create_project(project_name="EXPAI Docs", 
                             project_description="We are creating a sample project for EXPAI Docs")

expai.ExpaiAccount.project_list

List all projects available in your account

ExpaiAccount.project_list(self, search_by: str = None, exact_search: str = None)

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

expai_account.project_list()

expai.ExpaiAccount.delete_project

Delete a project from your account

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

ExpaiAccount.delete_project(self, project_name: str = None, project_id: str = None)

Attribute	Description	Required
project_name	Exact name of the project to be deleted.	Yes, if project_id is not provided
project_id	Unique identifier of the project to be deleted.	Yes, if project_name is not provided

expai_account.delete_project(project_name="EXPAI Docs")

expai.ExpaiAccount.update_project

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

ExpaiAccount.update_project(self, project_name: str = None, project_id: str = None, update_info: dict = None)

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

expai_account.update_project(project_name="EXPAI Docs",
                             update_info={"project_description_des":"New description"})

expai.ExpaiAccount.get_project

This method returns a Project object that enables interaction with its content (Models, Datasets, Explanations, Fairness).

ExpaiAccount.get_project(self, project_name: str = None, project_id: str = None)

Attribute	Description	Required
project_name	Exact name of the project to be retrieved.	Yes, if project_id is not provided
project_id	Unique identifier of the project to be retrieved.	Yes, if project_name is not provided

my_project = expai_account.get_project(project_name="EXPAI Docs")