Skip to content

Commit e5d5c9a

Browse files
authored
Dynamic mode: add augmentation gallery (#6057)
- Dynamic mode augmentation gallery notebook - Adds Dynamic Mode section to the examples section of the documentation - Sphinx 8.x Compatibility Signed-off-by: Joaquin Anton Guirao <[email protected]>
1 parent 88d15e1 commit e5d5c9a

File tree

5 files changed

+412
-2
lines changed

5 files changed

+412
-2
lines changed

docs/conf.py

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -521,20 +521,35 @@ def filter_members(self, members, want_all):
521521
the ones we're interested in.
522522
We can do the sorting here based on the values, and pass through in self.sort_members()
523523
"""
524+
524525
# Since pybind11 https://github.com/pybind/pybind11/pull/2739 there is an extra `value`
525526
# member returned by get_object_members().
526527
# Here we are filtering the list, to keep only enum members
528+
def get_member_name(member):
529+
# Sphinx 8.x: ObjectMember with __name__ attribute
530+
# Older Sphinx: tuple (name, value, docstring)
531+
if hasattr(member, "__name__"):
532+
return member.__name__
533+
else:
534+
return member[0]
535+
527536
filtered = [
528537
member
529538
for member in members
530-
if member[0] in self.object.__members__.keys()
539+
if get_member_name(member) in self.object.__members__.keys()
531540
]
532541

533542
filtered = super().filter_members(filtered, want_all)
534543

535544
# sort by the actual value of enum - this is a tuple of (name, value, boolean)
545+
# In Sphinx 8.x, it's an ObjectMember with .object attribute
536546
def get_member_value(member_desc):
537-
_, member_value, _ = member_desc
547+
if hasattr(member_desc, "object"):
548+
# Sphinx 8.x: ObjectMember
549+
member_value = member_desc.object
550+
else:
551+
# Older Sphinx: tuple unpacking
552+
_, member_value, _ = member_desc
538553
if isinstance(member_value, Enum):
539554
return member_value.value
540555
else:

docs/examples/dynamic_mode/augmentation_gallery.ipynb

Lines changed: 345 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
from doc_index import doc, doc_entry, op_reference
16+
17+
doc(
18+
title="Dynamic Mode",
19+
underline_char="=",
20+
entries=[
21+
doc_entry(
22+
"augmentation_gallery.ipynb",
23+
[
24+
op_reference("dynamic.erase", "Augmentation gallery"),
25+
op_reference("dynamic.water", "Augmentation gallery"),
26+
op_reference("dynamic.sphere", "Augmentation gallery"),
27+
op_reference("dynamic.warp_affine", "Augmentation gallery"),
28+
op_reference(
29+
"dynamic.jpeg_compression_distortion",
30+
"Augmentation gallery",
31+
),
32+
op_reference("dynamic.paste", "Augmentation gallery"),
33+
op_reference("dynamic.flip", "Augmentation gallery"),
34+
op_reference("dynamic.rotate", "Augmentation gallery"),
35+
op_reference("dynamic.hsv", "Augmentation gallery"),
36+
op_reference(
37+
"dynamic.brightness_contrast", "Augmentation gallery"
38+
),
39+
],
40+
),
41+
],
42+
)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Dynamic Mode
2+
============
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
augmentation_gallery.ipynb

docs/examples/index.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
],
3838
),
3939
"operations_index.py",
40+
"dynamic_mode/index.py",
4041
"use_cases/index.py",
4142
"other_index.py",
4243
],

0 commit comments

Comments
 (0)