rhino_health.lib.endpoints.aimodel.aimodel_endpoints#

Module Contents#

Classes#

AIModelEndpoints

Rhino SDK LTS supported endpoints

class rhino_health.lib.endpoints.aimodel.aimodel_endpoints.AIModelEndpoints(session)#

Bases: rhino_health.lib.endpoints.endpoint.Endpoint

Rhino SDK LTS supported endpoints

get_aimodel(self, aimodel_uid: str)#

Returns a AIModel dataclass

Parameters
aimodel_uid: str

UID for the aimodel

Returns
aimodel: AIModel

AIModel dataclass

Examples

>>> session.aimodel.get_aimodel(my_aimodel_uid)
AIModel()
create_aimodel(self, aimodel: rhino_health.lib.endpoints.aimodel.aimodel_dataclass.AIModelCreateInput)#

Returns a AIModel dataclass

Parameters
aimodel: AIModelCreateInput

AIModelCreateInput data class

Returns
aimodel: AIModel

AIModel dataclass

Examples

>>> session.aimodel.create_aimodel(create_aimodel_input)
AIModelCreateInput()
run_aimodel(self, aimodel: rhino_health.lib.endpoints.aimodel.aimodel_dataclass.AIModelRunInput)#

Returns a model_action_uid

Parameters
aimodel: AIModelRunInput

RunAIModelInput data class

Returns
model_action_uid: str

Examples

>>> session.aimodel.run_aimodel(run_aimodel_input)
AIModelRunInput()
train_aimodel(self, aimodel: rhino_health.lib.endpoints.aimodel.aimodel_dataclass.AIModelTrainInput)#

Returns a dict {status, d}

Parameters
aimodel: AIModelTrainInput

AIModelTrainInput data class

Returns
model_action_uid: str

Examples

>>> session.aimodel.train_aimodel(run_nvflare_aimodel_input)
AIModelTrainInput()