Skip to content

Add output docs#1908

Draft
klecki wants to merge 3 commits into
NVIDIA:mainfrom
klecki:output-docs
Draft

Add output docs#1908
klecki wants to merge 3 commits into
NVIDIA:mainfrom
klecki:output-docs

Conversation

@klecki

@klecki klecki commented Apr 27, 2020

Copy link
Copy Markdown
Contributor

Why we need this PR?

We want output docs

Replaces #1828.

TODO:

  • Introduce default placeholder when sample shape is not provided,
  • unify formatting of layout and sample shape,
  • apply the sample way to all xD TensorList of something -> sample ..., <type>

What happened in this PR?

Fill relevant points, put NA otherwise. Replace anything inside []

  • What solution was applied:
    [ Explain solution of the problem, a new feature added here. ]
  • Affected modules and functionalities:
    [ Describe here what was changed, added, removed. ]
  • Key points relevant for the review:
    [ Describe here what is the most important part that reviewers should focus on. ]
  • Validation and testing:
    [ Describe here if and how this PR is tested. ]
  • Documentation (including examples):
    [ Describe here if documentation and examples were updated. ]

JIRA TASK: [Use DALI-XXXX or NA]

klecki added 3 commits April 27, 2020 15:47
…eturns

Introduce OutputDoc and OutputDocStr as a mechanism
for creating Returns section for Operator __call__,
 similar to InputDoc & InputDocString that were already present.

Allow for unnamed outputs

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
TODO: Incorporate layouts, maybe unify them?

Adjust everything

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
@klecki klecki mentioned this pull request May 14, 2020
@JanuszL JanuszL changed the base branch from master to main May 19, 2021 12:24
@dali-automaton

Copy link
Copy Markdown
Collaborator

CI MESSAGE: [3840117]: BUILD FAILED

@klecki

klecki commented Mar 24, 2025

Copy link
Copy Markdown
Contributor Author

!build

@dali-automaton

Copy link
Copy Markdown
Collaborator

CI MESSAGE: [25952060]: BUILD FAILED

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants