G-API: Documentation for Params (IE and ONNX).#20112
Conversation
|
BTW, In documentation PRs it makes sense to update PR's description with link on generated affected documentation pages (after "Docs" builder is completed). Link should point somewhere here: http://pullrequest.opencv.org/buildbot/export/pr/20112/docs/ This is extremely useful for reviewers. |
dmatveev
left a comment
There was a problem hiding this comment.
Good start! Need to make it a little bit more comprehensive
f3a401a to
d23d02b
Compare
| }; | ||
|
|
||
| Params<Net>& cfgInputLayers(const typename PortCfg<Net>::In &ll) { | ||
| /** @brief Specifies sequence of CNN input layers names for inference. |
There was a problem hiding this comment.
I wouldn't hardcode to CNN networks, it works with any networks right ?
There was a problem hiding this comment.
Changed. network instead CNN.
| Params& pluginConfig(const IEConfig& cfg) { | ||
| desc.config = cfg; | ||
| /** @overload | ||
| Function with an rvalue parameter. |
| std::string device_id; //!< Device specifier. | ||
|
|
||
| // NB: Here order follows the `Net` API | ||
| std::vector<std::string> input_names; //!< Names of input CNN layers. |
There was a problem hiding this comment.
Names of input network layers
There was a problem hiding this comment.
I would stop using CNN for all entities below
dmatveev
left a comment
There was a problem hiding this comment.
Please align the ONNX documentation with the feedback on the IE stuctures (hide paramdesc, etc)
| } | ||
|
|
||
| /** @overload | ||
| Function for reshape by image size. |
There was a problem hiding this comment.
This function doesn't reshape any images
| The function is used to set names of layers that will be used for network reshape. | ||
| Dimensions will be constructed automatically by current network input and height and | ||
| width of image. |
There was a problem hiding this comment.
Please align with the rest of the reshape documentation
| Function with a rvalue parameters for reshape by image size. | ||
|
|
||
| @param layer_names rvalue set of the selected layers will be reshaped automatically | ||
| its input image size. | ||
| @return the reference on modified object. |
There was a problem hiding this comment.
No need to document the rvalue specifics, simply mention the overload.
|
@mpashchenkov is there any updates atop of the last (6d ago) review? |
dmatveev
left a comment
There was a problem hiding this comment.
@TolyaTalamanov please review my comments carefully.
0da717b to
74d5454
Compare
G-API: Documentation for Params (IE and ONNX). * Applying comments * Removed type of model from PramsDesc * Added message for onnx ParamDesc * Whitespaces * Review * Fix comments to review * Fix comments Co-authored-by: Anatoliy Talamanov <anatoliy.talamanov@intel.com>
Documentation for cfg_functions of Params.
Docs: http://pullrequest.opencv.org/buildbot/export/pr/20112/docs/
Pull Request Readiness Checklist
See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request
Patch to opencv_extra has the same branch name.
Magic commands: