Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tutorials references to ops docs - general section #3869

Merged
merged 3 commits into from
May 10, 2022

Conversation

awolant
Copy link
Contributor

@awolant awolant commented May 4, 2022

Signed-off-by: Albert Wolant awolant@nvidia.com

Category:

Refactoring: Add tutorials references to ops docs - general section

Description:

Add tutorials references to ops docs - general section

Additional information:

Affected modules and functionalities:

Docs

Key points relevant for the review:

Are proper ops referenced

Checklist

Tests

  • Existing tests apply
  • New tests added
    • Python tests
    • GTests
    • Benchmark
    • Other
  • N/A

Documentation

  • Existing documentation applies
  • Documentation updated
    • Docstring
    • Doxygen
    • RST
    • Jupyter
    • Other
  • N/A

DALI team only

Requirements

  • Implements new requirements
  • Affects existing requirements
  • N/A

REQ IDs: N/A

JIRA TASK: DALI-2718

Signed-off-by: Albert Wolant <awolant@nvidia.com>
@awolant
Copy link
Contributor Author

awolant commented May 4, 2022

!build

"tensor_join.ipynb",
op_reference('fn.cat', "Tutorial describing tensor joining")),
doc_entry(
"reinterpret.ipynb",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should add squeeze, expand_dims and reinterpret as this tutorial describes them as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

"reductions.ipynb",
op_reference('fn.reductions', "Tutorial describing how to use reductions")),
doc_entry(
"tensor_join.ipynb",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to list stack here as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [4747915]: BUILD STARTED

@JanuszL JanuszL self-assigned this May 4, 2022
Signed-off-by: Albert Wolant <awolant@nvidia.com>
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [4747915]: BUILD PASSED

Comment on lines 26 to 28
op_reference('fn.transforms', "Tutorial describing tensor geometric transformations"),
op_reference('fn.warp_affine', "Tutorial describing tensor geometric transformations"),
op_reference('fn.coord_transform', "Tutorial describing tensor geometric transformations")]),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just point of view. Maybe we can a bit farther and write which particular aspect this tutorial is touching, like:

Suggested change
op_reference('fn.transforms', "Tutorial describing tensor geometric transformations"),
op_reference('fn.warp_affine', "Tutorial describing tensor geometric transformations"),
op_reference('fn.coord_transform', "Tutorial describing tensor geometric transformations")]),
op_reference('fn.transforms', "Tutorial describing tensor geometric transformations to transform points and images"),
op_reference('fn.warp_affine', "Tutorial showing how to use afine transform"),
op_reference('fn.coord_transform', "Tutorial describing how to transform points accompanying images")]),

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Signed-off-by: Albert Wolant <awolant@nvidia.com>
@awolant
Copy link
Contributor Author

awolant commented May 4, 2022

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [4750729]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [4750729]: BUILD PASSED

@awolant awolant merged commit f64cb42 into NVIDIA:main May 10, 2022
cyyever pushed a commit to cyyever/DALI that referenced this pull request May 13, 2022
* Add tutorials references to ops docs

Signed-off-by: Albert Wolant <awolant@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jun 7, 2022
* Add tutorials references to ops docs

Signed-off-by: Albert Wolant <awolant@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants