Projects

A project is the collection of your labeled sensor data and algorithms used to build your application.

Examples:

client.projects = 'My Project'

client.project.columns()

client.project..metadata_columns()

client.project.labels()

This file is part of SensiML™ Piccolo AI™.

SensiML Piccolo AI is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

SensiML Piccolo AI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with SensiML Piccolo AI. If not, see <https://www.gnu.org/licenses/>.

class sensiml.datamanager.projects.Projects(connection: Connection)

Base class for a collection of projects.

build_project_dict() → dict: Populates the function_list property from the server.

create_project(name: str)

Creates a project using the name property.

Parameters: name (str) – name of the new project
Returns: project
Raises: ProjectExistsError, if the project already exists on the server –

get_or_create_project(name: str)

Calls the REST API and gets the project by name, if it doesn’t exist insert a new project

Parameters: name (str) – name of the project
Returns: project object

get_project_by_name(name: str)

gets a project from the server using its name property

Parameters: name (str) – name of the project
Returns: project or None if project does not exist

get_projects() → list[sensiml.datamanager.project.Project]

Gets all projects from the server as project objects.

Returns: list[project]

new_project(data: Optional[dict] = None) → Project

Creates a new project.

Parameters: dict (dict) – dictionary containing the attributes of the new project
Returns: project

This file is part of SensiML™ Piccolo AI™.

SensiML Piccolo AI is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

SensiML Piccolo AI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with SensiML Piccolo AI. If not, see <https://www.gnu.org/licenses/>.

class sensiml.datamanager.project.Project(connection: Connection)

Base class for a project.

add_segmenter(name: str, segmenter: FunctionCall, preprocess: Optional[dict] = None, custom: bool = False) → Response

Saves a segmentation algorithm as the project’s global segmentation setting.

Parameters

name (str) – Name to call the segmenter
segmenter (FunctionCall) – segmentation call object that the project will use by default
preprocess (dict) – Segment transforms to perform before segmenter
custom (bool) – a custom segmenter, or one of our server side segmenters

columns() → list[str]

Returns the sensor columns available in the project.

Returns: a list of string names of the project’s sensor columns
Return type: columns (list[str])

property created_at: datetime: Date of the project creation

delete() → Response: Calls the REST API to delete the object.

delete_async() → Response: Calls the Async REST API to delete the project.

delete_async_status() → Response: Calls the Async REST API to get the status of deleting the project.

delete_async_stop() → Response: Calls the Async REST API to stop deleting the project.

get_knowledgepack(kp_uuid: str) → KnowledgePack

Gets the KnowledgePack(s) created by the sandbox.

Returns: a KnowledgePack instance, list of instances, or None

initialize_from_dict(data: dict)

Reads a json dict and populates a single project.

Parameters: dict (dict) – contains the project’s ‘name’, ‘uuid’, ‘schema’, and ‘settings’ properties

insert() → Response: Calls the REST API to insert a new object, uses only the name and schema.

label_columns() → list[str]

Returns the label columns available in the project.

Returns: a list of string names of the project’s metadata columns
Return type: columns (list[str])

list_knowledgepacks() → DataFrame

Lists all of the knowledgepacks associated with this project

Returns: knowledgepacks on kb cloud
Return type: DataFrame

metadata_columns() → list[str]

Returns the metadata columns available in the project.

Returns: a list of string names of the project’s metadata columns
Return type: columns (list[str])

property name: str: Name of the project object

property plugin_config: dict: Plugin Config of the project object

refresh() → Response: Calls the REST API and self populates from the server.

property schema: dict: Schema of the project object

property settings: dict: Global settings of the project object

statistics() → DataFrame

Gets all capture statistics for the project.

Returns: DataFrame of capture statistics

update() → Response: Calls the REST API to update the object.

property uuid: str: Auto generated unique identifier for the project object