Separate the documentation pages! #3794
Conversation
|
!build |
|
CI MESSAGE: [4431171]: BUILD STARTED |
|
CI MESSAGE: [4431171]: BUILD PASSED |
dali/python/nvidia/dali/fn.py
Outdated
| @@ -89,6 +89,7 @@ def fn_wrapper(*inputs, **kwargs): | |||
| fn_wrapper.__name__ = wrapper_name | |||
| fn_wrapper.__qualname__ = wrapper_name | |||
| fn_wrapper.__doc__ = wrapper_doc | |||
| fn_wrapper._schema_name = op_class.schema_name | |||
There was a problem hiding this comment.
I'd suggest passing the op_class, not just the name - that way we'd have access to whatever properties of the underlying op class we want.
| fn_wrapper._schema_name = op_class.schema_name | |
| fn_wrapper._op_class = op_class |
Also, please add it also to op_wrapper, too. I think this code needs some cleanup after the introduction of debug mode... :\
There was a problem hiding this comment.
Probably this change or anything related should be made it separate PR not during docs rework.
I am a bit worried about tying the whole class to the fn functions, but those are private members, and who checks the members of the functions?
docs/_static/redirect.js
Outdated
| @@ -0,0 +1,21 @@ | |||
| // TODO(klecki): doesn't work, how to include it? | |||
There was a problem hiding this comment.
Is this meant to stay?
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
klecki
force-pushed
the
spearate-doc-pages
branch
from
7bfe55b
to
db4686e
Compare
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
!build |
|
CI MESSAGE: [4452175]: BUILD STARTED |
|
CI MESSAGE: [4452175]: BUILD FAILED |
|
CI MESSAGE: [4452175]: BUILD PASSED |
Make every operator function from fn API appear as separate page in the documentation. Add a redirect from old operator link to the new one, mapping: `supported_ops.html#nvidia.dali.fn.operator_name` to: `operations/nvidia.dali.fn.operator_name.html` Adjust the old style URLs in examples. Correct few typos. Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Make every operator function from fn API appear as separate page in the documentation. Add a redirect from old operator link to the new one, mapping: `supported_ops.html#nvidia.dali.fn.operator_name` to: `operations/nvidia.dali.fn.operator_name.html` Adjust the old style URLs in examples. Correct few typos. Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Category: Other
Description:
Make every operator appear as separate function
in the documentation.
Few hacks needed:
Turns out that it's really hard to get the canonicalname of the op and schema from the POV of fn API.
So I added a
_schema_namemember, maybe thereis better way to be suggested?
Now available as #3798
All the pages are generated into one
operationsdirectory,mainly to not pollute the docs/ during build, but it has
a side effect of appearing in the url. Do we want to inlcude
more of it (module name) as a url hierarchy or are we fine as
it is now?
Redirect didn't work, I need a JS/HTML magician.This is fine now.
The operations table works on the old API access
and I have no intention of refactoring it.
Additional information:
Affected modules and functionalities:
Key points relevant for the review:
Checklist
Tests
Documentation
DALI team only
Requirements
REQ IDs: N/A
JIRA TASK: N/A