Package: sclblpy
sclblpysclblpyis the core python package provided by Scailable for interacting with our API.sclblpyis only functional in combination with a valid Scailable user account.Website:https://www.scailable.netDocs:On GitHub (you are here):https://github.com/scailable/sclblpyAPI docs Scailable:https://docs.sclbl.netThe scope of this package is:Manage scailable account (auth.py)Create an account in the scailable plateformSign in to an existing accountReset password or set a new passwordGet account informationManage models (compute.py)Upload an.onnxmodel to the ScailableUpdate an existing modelDelete a modelGet model's detailsGet all the models accessible to your organisation.Add a catalogue (set of models) to your organisationUpdate an existing catalogueDelete a catalogueGet catalogue's detailsGet all the catalogues accessible for your organisation.Get the configured parameters for serviceGet statistics of all models for your organisationManage devices (device.py)Add a device to your organisationUpdate a deviceGet device's detailsAssign a model to a deviceDelete a deviceGet devices statisticsGet all devices accessible for your organisationGet all groups accessible for your organisationDelete a groupAdd a device to a groupDelete a device from a groupGetting startedGet a Scailable accountTo create a Scailable account you can useregister_()function or sign up athttps://admin.sclbl.net/registerdefregister_(name:str,company:str,email:str,password:str,job_title:str,phone_number:str,newsletter_optIn:bool=True,accept_eula:bool=True)->bool:"""Performs the sign-up of a user.The function register performs a sign-up of a new user.It returns a boolean value indicating whether the sign-up was successful.Args:name: A string (name of the user)company: A string (name of the user's company)email: A string (email)password: A string (password)job_title: A string (job of the user)phone_number: A string (user's phone number)newsletter_optIn: Bool (whether to add this email address to the newsletter)accept_eula: Bool (Agreement to the EULA)Returns:True if sign-up is successful."""You already have a Scailable account? then you can sign in to your account usinglog_infunction.deflog_in(email:str,password:str)->bool:"""Performs the sign in of a user.The function _log_in performs a log in of a user basedon the email (str) and password (str). It returnsa boolean value indicating whether the log in was successful.Args:email: A string (email) to log in the userpassword: A string (password) for loginReturns:True if sign in is successful."""The following functionalities are likely most used:Upload anonnxmodelTo upload your models to Scailable, you can use_upload_model. (only models with onnx format are accepted)defupload_model(name:str,documentation:str,input_driver:str="",input_driver_details:dict={},output_driver:str="",output_driver_details:dict={},alias:str="",path:str="",source_name=None,source_url=None)->bool:"""_upload_model uploads a fitted onnx model to Scailable.- The function first checks if the supplied path indeed references a .onnx file- Next the onnx file and the supporting docs are uploaded.Args:name: Name of the model to uploadinput_driver:input_driver_details:output_driver:output_driver_details:alias: Alias of the modeldocumentation: Documentation of the modelpath: The path referencing the onnx model location (i.e., the .onnx file location).source_name:source_url:Returns:False if upload failed, True otherwise"""Add a deviceTo add a device to Scailable, you can useadd_device.defadd_device(name:str,registration_token:str="",runtime:str="",serial:str="",type:str="")->bool:"""Add device to user's organisation.Args:name: Name of the model to uploadregistration_token:runtime:serial:type:Returns:True if device added, False otherwise"""Assign a model to a deviceTo assign a model to your device, you can use_assign_model_to_device.defassign_model_to_device(uuid:str,function_uuid:str)->bool:"""Assign a model to a device.Args:uuid: UUID of the deviceReturns:True if model assigned, False otherwise"""