Python Client

The SensiML class has multiple functions for exploring your project

Examples:

from sensiml import SensiML
dsk = SensiML()

dsk.list_projects()
dsk.project = "MyProject"

dsk.list_captures()
class sensiml.client.SensiML(server='https://sensiml.cloud/', path='connect.cfg', use_jedi=False, **kwargs)

Entrance to SensiML Analytic Suite

create_query(name, columns=[], metadata_columns=[], metadata_filter='', segmenter=None, label_column='', combine_labels=None, force=False, renderer=None, capture_configurations='')

Create a query to use as input data in a pipeline.

Parameters
  • name (str) – Name of the query.

  • columns (list, optional) – Columns to add to the query result.

  • metadata_columns (list, optional) – Metadata to add to the query result.

  • metadata_filter (str, optional) – Filter to apply to the query.

  • segmenter (int, optional) – Segmenter to filter query by.

  • force (bool, False) – If True overwrite the query on kb cloud.

Returns

Returns a query object that was created.

Return type

object

delete_project()

Deletes a project

function_description(name)

Gets a description of a pipeline function.

function_help(name)

Prints a shortened description of a function.

get_function(name)

Gets a function method call

get_knowledgepack(uuid)

retrieve knowledgepack by uuid from the server associated with current project

Parameters

uuid (str) – unique identifier for knowledgepack

Returns

a knowledgepack object

Return type

TYPE

list_functions(functype=None, subtype=None, kp_functions=False, qgrid=True)

Lists all of the functions available on SensiML Cloud

Returns

Dataframe

Parameters
  • functype (str, None) – Return only functions with the specified type. ie. “Segmenter”

  • subtype (str, None) – Return only functions with the specified subtype. ie. “Sensor”

  • kp_functions (boolean, True) – Return only functions that run on tbe loaded to a device.

  • functions such as feature selection and model training. (Excludes) –

list_knowledgepacks(unnamed=False)

Lists all of the knowledgepacks associated with a team

Returns

knowledgepacks on SensiML Cloud

Return type

DataFrame

list_seeds()

Lists all of the pipeline seeds on SensiML Cloud

Returns

pipeline seeds on SensiML Cloud

Return type

DataFrame

logout(name=None)

Logs out of the current connection.

property pipeline

The active pipeline

property project

The active project

setup_jedi_false()

This is a temporary bug fix in ipython autocomplete

upload_data_file(name, path, force=False)

Upload data source from local CSV file

upload_dataframe(name, dataframe, force=False)

Set data source from a pandas DataFrame.

validate_client_version(skip_validate=True)

Perform a Validation check to see if this version of SensiML is up to date with the latest.