[Python API][Docs] Fix references for several classes (#11251)
This commit is contained in:
Anastasia Kuporosova
committed by
GitHub
GitHub
parent
932f8bf767
commit
9fa5150d71
@@ -67,7 +67,7 @@ void regclass_graph_Model(py::module m) {
|
||||
:param results: List of results.
|
||||
:type results: List[op.Result]
|
||||
:param sinks: List of Nodes to be used as Sinks (e.g. Assign ops).
|
||||
:type sinks: List[Node]
|
||||
:type sinks: List[openvino.runtime.Node]
|
||||
:param parameters: List of parameters.
|
||||
:type parameters: List[op.Parameter]
|
||||
:param name: String to set as function's friendly name.
|
||||
@@ -87,7 +87,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Create user-defined Model which is a representation of a model.
|
||||
|
||||
:param results: List of Nodes to be used as results.
|
||||
:type results: List[Node]
|
||||
:type results: List[openvino.runtime.Node]
|
||||
:param parameters: List of parameters.
|
||||
:type parameters: List[op.Parameter]
|
||||
:param name: String to set as function's friendly name.
|
||||
@@ -107,7 +107,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Create user-defined Model which is a representation of a model.
|
||||
|
||||
:param result: Node to be used as result.
|
||||
:type result: Node
|
||||
:type result: openvino.runtime.Node
|
||||
:param parameters: List of parameters.
|
||||
:type parameters: List[op.Parameter]
|
||||
:param name: String to set as function's friendly name.
|
||||
@@ -126,7 +126,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Create user-defined Model which is a representation of a model
|
||||
|
||||
:param results: List of outputs.
|
||||
:type results: List[Output]
|
||||
:type results: List[openvino.runtime.Output]
|
||||
:param parameters: List of parameters.
|
||||
:type parameters: List[op.Parameter]
|
||||
:param name: String to set as function's friendly name.
|
||||
@@ -149,9 +149,9 @@ void regclass_graph_Model(py::module m) {
|
||||
Create user-defined Model which is a representation of a model
|
||||
|
||||
:param results: List of outputs.
|
||||
:type results: List[Output]
|
||||
:type results: List[openvino.runtime.Output]
|
||||
:param sinks: List of Nodes to be used as Sinks (e.g. Assign ops).
|
||||
:type sinks: List[Node]
|
||||
:type sinks: List[openvino.runtime.Node]
|
||||
:param name: String to set as function's friendly name.
|
||||
:type name: str
|
||||
)");
|
||||
@@ -175,7 +175,7 @@ void regclass_graph_Model(py::module m) {
|
||||
:param results: List of results.
|
||||
:type results: List[op.Result]
|
||||
:param sinks: List of Nodes to be used as Sinks (e.g. Assign ops).
|
||||
:type sinks: List[Node]
|
||||
:type sinks: List[openvino.runtime.Node]
|
||||
:param parameters: List of parameters.
|
||||
:type parameters: List[op.Parameter]
|
||||
:param variables: List of variables.
|
||||
@@ -202,9 +202,9 @@ void regclass_graph_Model(py::module m) {
|
||||
Create user-defined Model which is a representation of a model
|
||||
|
||||
:param results: List of results.
|
||||
:type results: List[Output]
|
||||
:type results: List[openvino.runtime.Output]
|
||||
:param sinks: List of Nodes to be used as Sinks (e.g. Assign ops).
|
||||
:type sinks: List[Node]
|
||||
:type sinks: List[openvino.runtime.Node]
|
||||
:param variables: List of variables.
|
||||
:type variables: List[op.util.Variable]
|
||||
:param name: String to set as function's friendly name.
|
||||
@@ -250,7 +250,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Create user-defined Model which is a representation of a model
|
||||
|
||||
:param results: List of results.
|
||||
:type results: List[Output]
|
||||
:type results: List[openvino.runtime.Output]
|
||||
:param parameters: List of parameters.
|
||||
:type parameters: List[op.Parameter]
|
||||
:param name: String to set as function's friendly name.
|
||||
@@ -267,7 +267,7 @@ void regclass_graph_Model(py::module m) {
|
||||
py::arg("partial_shape"),
|
||||
R"(
|
||||
:param partial_shape: New shape.
|
||||
:type partial_shape: PartialShape
|
||||
:type partial_shape: openvino.runtime.PartialShape
|
||||
:return : void
|
||||
)");
|
||||
|
||||
@@ -364,7 +364,7 @@ void regclass_graph_Model(py::module m) {
|
||||
(4) `-1` is a dynamic dimension without known bounds
|
||||
(4) `openvino.runtime.Dimension`
|
||||
(5) `str` using next syntax:
|
||||
'?' - to define fully dinamic dimension
|
||||
'?' - to define fully dynamic dimension
|
||||
'1' - to define dimension which length is 1
|
||||
'1..10' - to define bounded dimension
|
||||
'..10' or '1..' to define dimension with only lower or only upper limit
|
||||
@@ -387,7 +387,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Return ops used in the function.
|
||||
|
||||
:return: List of Nodes representing ops used in function.
|
||||
:rtype: List[Node]
|
||||
:rtype: List[openvino.runtime.Node]
|
||||
)");
|
||||
function.def("get_ordered_ops",
|
||||
&ov::Model::get_ordered_ops,
|
||||
@@ -395,7 +395,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Return ops used in the function in topological order.
|
||||
|
||||
:return: List of sorted Nodes representing ops used in function.
|
||||
:rtype: List[Node]
|
||||
:rtype: List[openvino.runtime.Node]
|
||||
)");
|
||||
function.def("get_output_op",
|
||||
&ov::Model::get_output_op,
|
||||
@@ -406,7 +406,7 @@ void regclass_graph_Model(py::module m) {
|
||||
:param index: output index
|
||||
:type index: output index
|
||||
:return: Node object that generates output i
|
||||
:rtype: Node
|
||||
:rtype: openvino.runtime.Node
|
||||
)");
|
||||
function.def("get_output_element_type",
|
||||
&ov::Model::get_output_element_type,
|
||||
@@ -417,7 +417,7 @@ void regclass_graph_Model(py::module m) {
|
||||
:param index: output index
|
||||
:type index: int
|
||||
:return: Type object of output i
|
||||
:rtype: Type
|
||||
:rtype: openvino.runtime.Type
|
||||
)");
|
||||
function.def("get_output_shape",
|
||||
&ov::Model::get_output_shape,
|
||||
@@ -428,7 +428,7 @@ void regclass_graph_Model(py::module m) {
|
||||
:param index: element index
|
||||
:type index: int
|
||||
:return: Shape object of element i
|
||||
:rtype: Shape
|
||||
:rtype: openvino.runtime.Shape
|
||||
)");
|
||||
function.def("get_output_partial_shape",
|
||||
&ov::Model::get_output_partial_shape,
|
||||
@@ -439,7 +439,7 @@ void regclass_graph_Model(py::module m) {
|
||||
:param index: element index
|
||||
:type index: int
|
||||
:return: PartialShape object of element i
|
||||
:rtype: PartialShape
|
||||
:rtype: openvino.runtime.PartialShape
|
||||
)");
|
||||
function.def("get_parameters",
|
||||
&ov::Model::get_parameters,
|
||||
@@ -463,7 +463,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Return single result.
|
||||
|
||||
:return: Node object representing result.
|
||||
:rtype: Node
|
||||
:rtype: openvino.runtime.Node
|
||||
)");
|
||||
function.def("get_result_index",
|
||||
(int64_t(ov::Model::*)(const ov::Output<ov::Node>&) const) & ov::Model::get_result_index,
|
||||
@@ -474,7 +474,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Return -1 if `value` not matched.
|
||||
|
||||
:param value: Output containing Node
|
||||
:type value: Output
|
||||
:type value: openvino.runtime.Output
|
||||
:return: Index for value referencing it.
|
||||
:rtype: int
|
||||
)");
|
||||
@@ -487,7 +487,7 @@ void regclass_graph_Model(py::module m) {
|
||||
Return -1 if `value` not matched.
|
||||
|
||||
:param value: Output containing Node
|
||||
:type value: Output
|
||||
:type value: openvino.runtime.Output
|
||||
:return: Index for value referencing it.
|
||||
:rtype: int
|
||||
)");
|
||||
@@ -652,13 +652,13 @@ void regclass_graph_Model(py::module m) {
|
||||
Evaluate the function on inputs, putting results in outputs
|
||||
|
||||
:param output_tensors: Tensors for the outputs to compute. One for each result
|
||||
:type output_tensors: List[op.Tensor]
|
||||
:type output_tensors: List[openvino.runtime.Tensor]
|
||||
:param input_tensors: Tensors for the inputs. One for each inputs.
|
||||
:type input_tensors: List[op.Tensor]
|
||||
:type input_tensors: List[openvino.runtime.Tensor]
|
||||
:param evaluation_context: Storage of additional settings and attributes that can be used
|
||||
when evaluating the function. This additional information can be
|
||||
shared across nodes.
|
||||
:type evaluation_context: PyRTMap
|
||||
:type evaluation_context: openvino.runtime.RTMap
|
||||
:rtype: bool
|
||||
)");
|
||||
|
||||
|
||||
@@ -95,12 +95,12 @@ void regclass_graph_Node(py::module m) {
|
||||
Evaluate the node on inputs, putting results in outputs
|
||||
|
||||
:param output_tensors: Tensors for the outputs to compute. One for each result.
|
||||
:type output_tensors: List[op.Tensor]
|
||||
:type output_tensors: List[openvino.runtime.Tensor]
|
||||
:param input_tensors: Tensors for the inputs. One for each inputs.
|
||||
:type input_tensors: List[op.Tensor]
|
||||
:type input_tensors: List[openvino.runtime.Tensor]
|
||||
:param evaluation_context: Storage of additional settings and attributes that can be used
|
||||
when evaluating the function. This additional information can be shared across nodes.
|
||||
:type evaluation_context: PyRTMap
|
||||
:type evaluation_context: openvino.runtime.RTMap
|
||||
:rtype: bool
|
||||
)");
|
||||
node.def(
|
||||
@@ -114,9 +114,9 @@ void regclass_graph_Node(py::module m) {
|
||||
Evaluate the function on inputs, putting results in outputs
|
||||
|
||||
:param output_tensors: Tensors for the outputs to compute. One for each result.
|
||||
:type output_tensors: List[op.Tensor]
|
||||
:type output_tensors: List[openvino.runtime.Tensor]
|
||||
:param input_tensors: Tensors for the inputs. One for each inputs.
|
||||
:type input_tensors: List[op.Tensor]
|
||||
:type input_tensors: List[openvino.runtime.Tensor]
|
||||
:rtype: bool
|
||||
)");
|
||||
node.def("get_input_tensor",
|
||||
@@ -129,7 +129,7 @@ void regclass_graph_Node(py::module m) {
|
||||
:param index: Index of Input.
|
||||
:type index: int
|
||||
:return: Tensor of the input i
|
||||
:rtype: descriptor.Tensor
|
||||
:rtype: openvino.pyopenvino.DescriptorTensor
|
||||
)");
|
||||
node.def("get_element_type",
|
||||
&ov::Node::get_element_type,
|
||||
@@ -137,7 +137,7 @@ void regclass_graph_Node(py::module m) {
|
||||
Checks that there is exactly one output and returns it's element type.
|
||||
|
||||
:return: Type of the output.
|
||||
:rtype: Type
|
||||
:rtype: openvino.runtime.Type
|
||||
)");
|
||||
node.def("input_values",
|
||||
&ov::Node::input_values,
|
||||
@@ -145,7 +145,7 @@ void regclass_graph_Node(py::module m) {
|
||||
Returns list of node's inputs, in order.
|
||||
|
||||
:return: List of node's inputs
|
||||
:rtype: List[Input]
|
||||
:rtype: List[openvino.runtime.Input]
|
||||
)");
|
||||
node.def("input_value",
|
||||
&ov::Node::input_value,
|
||||
@@ -156,7 +156,7 @@ void regclass_graph_Node(py::module m) {
|
||||
:param index: Index of Input.
|
||||
:type index: int
|
||||
:return: Input of this node.
|
||||
:rtype: Input
|
||||
:rtype: openvino.runtime.Input
|
||||
)");
|
||||
node.def("get_input_size",
|
||||
&ov::Node::get_input_size,
|
||||
@@ -183,7 +183,7 @@ void regclass_graph_Node(py::module m) {
|
||||
:param index: Index of the output.
|
||||
:type index: int
|
||||
:return: Type of the output i
|
||||
:rtype: Type
|
||||
:rtype: openvino.runtime.Type
|
||||
)");
|
||||
node.def("get_output_shape",
|
||||
&ov::Node::get_output_shape,
|
||||
@@ -194,7 +194,7 @@ void regclass_graph_Node(py::module m) {
|
||||
|
||||
:param index: Index of the output.
|
||||
:return: Shape of the output i
|
||||
:rtype: Shape
|
||||
:rtype: openvino.runtime.Shape
|
||||
)");
|
||||
node.def("get_output_partial_shape",
|
||||
&ov::Node::get_output_partial_shape,
|
||||
@@ -205,7 +205,7 @@ void regclass_graph_Node(py::module m) {
|
||||
:param index: Index of the output.
|
||||
:type index: int
|
||||
:return: PartialShape of the output i
|
||||
:rtype: PartialShape
|
||||
:rtype: openvino.runtime.PartialShape
|
||||
)");
|
||||
node.def("get_output_tensor",
|
||||
&ov::Node::get_output_tensor,
|
||||
@@ -217,14 +217,14 @@ void regclass_graph_Node(py::module m) {
|
||||
:param index: Index of the output.
|
||||
:type index: int
|
||||
:return: Tensor of the output i
|
||||
:rtype: descriptor.Tensor
|
||||
:rtype: openvino.pyopenvino.DescriptorTensor
|
||||
)");
|
||||
node.def("get_type_name",
|
||||
&ov::Node::get_type_name,
|
||||
R"(
|
||||
Returns Type's name from the node.
|
||||
|
||||
:return: String repesenting Type's name.
|
||||
:return: String representing Type's name.
|
||||
:rtype: str
|
||||
)");
|
||||
node.def("get_name",
|
||||
@@ -266,7 +266,7 @@ void regclass_graph_Node(py::module m) {
|
||||
:param input_index: Index of Input.
|
||||
:type input_index: int
|
||||
:return: Input of this node.
|
||||
:rtype: Input
|
||||
:rtype: openvino.runtime.Input
|
||||
)");
|
||||
node.def("inputs",
|
||||
(std::vector<ov::Input<ov::Node>>(ov::Node::*)()) & ov::Node::inputs,
|
||||
@@ -274,7 +274,7 @@ void regclass_graph_Node(py::module m) {
|
||||
A list containing a handle for each of this node's inputs, in order.
|
||||
|
||||
:return: List of node's inputs.
|
||||
:rtype: List[Input]
|
||||
:rtype: List[openvino.runtime.Input]
|
||||
)");
|
||||
node.def("output",
|
||||
(ov::Output<ov::Node>(ov::Node::*)(size_t)) & ov::Node::output,
|
||||
@@ -285,7 +285,7 @@ void regclass_graph_Node(py::module m) {
|
||||
:param output_index: Index of Output.
|
||||
:type output_index: int
|
||||
:return: Output of this node.
|
||||
:rtype: Output
|
||||
:rtype: openvino.runtime.Output
|
||||
)");
|
||||
node.def("outputs",
|
||||
(std::vector<ov::Output<ov::Node>>(ov::Node::*)()) & ov::Node::outputs,
|
||||
@@ -293,7 +293,7 @@ void regclass_graph_Node(py::module m) {
|
||||
A list containing a handle for each of this node's outputs, in order.
|
||||
|
||||
:return: List of node's outputs.
|
||||
:rtype: List[Output]
|
||||
:rtype: List[openvino.runtime.Output]
|
||||
)");
|
||||
node.def("get_rt_info",
|
||||
(PyRTMap & (ov::Node::*)()) & ov::Node::get_rt_info,
|
||||
@@ -302,7 +302,7 @@ void regclass_graph_Node(py::module m) {
|
||||
Returns PyRTMap which is a dictionary of user defined runtime info.
|
||||
|
||||
:return: A dictionary of user defined data.
|
||||
:rtype: PyRTMap
|
||||
:rtype: openvino.runtime.RTMap
|
||||
)");
|
||||
node.def("get_version",
|
||||
&ov::Node::get_version,
|
||||
|
||||
Reference in New Issue
Block a user