This PR fixes ambiguous docstrings in client code.
Describe your changes in detail
It fixes the docstring of the upload_model method in the client API.
model (str): Path to Onnx model file.
tensor_inputs (Union[List[List[int], ModelDatumType], List[List[List[int], ModelDatumType]]): The list of input fact and datum types for each input grouped together in lists, describing the different inputs of the model.
tensor_outputs (Union[ModelDatumType, List[ModelDatumType]): The list of datum types describing the different output types of the model. Defaults to ModelDatumType.F32.
shape (Tuple, optional): The shape of the model input. Defaults to None.
dtype (ModelDatumType, optional): The type of the model input data (f32 by default). Defaults to ModelDatumType.F32.
dtype_out (ModelDatumType, optional): The type of the model output data (f32 by default). Defaults to ModelDatumType.F32.
sign (bool, optional): Get signed responses from the server or not. Defaults to False.
model_name (Optional[str], optional): Name of the model.
Type of change
The types of changes must be deduced from the labels of the related issues. Please consider providing these further details.
[ ] This change requires a documentation update
[ ] This change affects the client
[ ] This change affects the server
[ ] This change affects the API
[x] This change only concerns the documentation
How Has This Been Tested?
Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc.
Checklist:
[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[ ] I have commented my code, particularly in hard-to-understand areas
[x] My changes generate no new warnings
[x] I have updated the documentation according to my changes
Description
This PR fixes ambiguous docstrings in client code.
Describe your changes in detail It fixes the docstring of the
upload_model
method in the client API.Type of change
The types of changes must be deduced from the labels of the related issues. Please consider providing these further details.
How Has This Been Tested?
Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc.
Checklist: