Skip to content

Pipeline documentation#440

Merged
kiritigowda merged 11 commits into
ROCm:developfrom
spolifroni-amd:spolifroni-amd/pipeline-doc
Jan 23, 2026
Merged

Pipeline documentation#440
kiritigowda merged 11 commits into
ROCm:developfrom
spolifroni-amd:spolifroni-amd/pipeline-doc

Conversation

@spolifroni-amd
Copy link
Copy Markdown
Contributor

Motivation

There's a lack of pipeline documentation and this is addressing that.
Other changes:

  • emphasizing that this is a python library
  • clarifying that the C++ api is for the backend only
  • editing the overview section (have turned that into operators for now)

@spolifroni-amd spolifroni-amd added documentation Improvements or additions to documentation ci:docs-only Skips most non-documentation CI for this PR labels Jan 6, 2026
@kiritigowda kiritigowda self-assigned this Jan 8, 2026
@spolifroni-amd spolifroni-amd marked this pull request as ready for review January 12, 2026 21:48
rrawther
rrawther previously approved these changes Jan 19, 2026
Comment thread docs/how-to/rocAL-use-pipeline.rst Outdated
Comment thread docs/index.rst Outdated
LakshmiKumar23
LakshmiKumar23 previously approved these changes Jan 20, 2026
@kiritigowda kiritigowda merged commit 1d396a8 into ROCm:develop Jan 23, 2026
3 checks passed
spolifroni-amd added a commit to spolifroni-amd/rocAL that referenced this pull request Mar 6, 2026
* initial commit of pipeline doc

* added info about how run doesn't need to be explicitly called with iterators

* added the pipeline howto

* added generic iterators api; updated the pipeline info

* updated the requirements.in to the latest minimum rocm-docs-core version

* updates based on review feedback

---------

Co-authored-by: Lakshmi Kumar <lakshmi.kumar@amd.com>
(cherry picked from commit 1d396a8)
spolifroni-amd added a commit that referenced this pull request Mar 6, 2026
* initial commit of pipeline doc

* added info about how run doesn't need to be explicitly called with iterators

* added the pipeline howto

* added generic iterators api; updated the pipeline info

* updated the requirements.in to the latest minimum rocm-docs-core version

* updates based on review feedback

---------


(cherry picked from commit 1d396a8)

Co-authored-by: Lakshmi Kumar <lakshmi.kumar@amd.com>
spolifroni-amd added a commit to spolifroni-amd/rocAL that referenced this pull request Apr 2, 2026
* initial commit of pipeline doc

* added info about how run doesn't need to be explicitly called with iterators

* added the pipeline howto

* added generic iterators api; updated the pipeline info

* updated the requirements.in to the latest minimum rocm-docs-core version

* updates based on review feedback

---------

(cherry picked from commit 1d396a8)

Co-authored-by: Lakshmi Kumar <lakshmi.kumar@amd.com>
(cherry picked from commit efee42e)
spolifroni-amd added a commit that referenced this pull request Apr 2, 2026
* Docs - Pipeline documentation (#440) (#460)

* initial commit of pipeline doc

* added info about how run doesn't need to be explicitly called with iterators

* added the pipeline howto

* added generic iterators api; updated the pipeline info

* updated the requirements.in to the latest minimum rocm-docs-core version

* updates based on review feedback

---------

(cherry picked from commit 1d396a8)

Co-authored-by: Lakshmi Kumar <lakshmi.kumar@amd.com>
(cherry picked from commit efee42e)

* Cherry picking the plugin augmentation docs (#465)

* Augment plugin documentation (#463)

* added iterator info to pytorch doc

* tensorflow + adding jupyter notebooks to pytorch

* updated some wording

* updated jax section

* small changes

* Update docs/how-to/rocAL-jax-framework.rst

Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>

* Update docs/how-to/rocAL-pytorch-framework.rst

Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>

* fixed based on review comments

* changed the Jax docker link

* removing claude-generated doc

* removed ROCAL_Iterator from tf

* fixed some wording

---------

Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Co-authored-by: Lakshmi Kumar <lakshmi.kumar@amd.com>
(cherry picked from commit 595a91d)

* fixing a broken link real quick

---------

Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Co-authored-by: Lakshmi Kumar <lakshmi.kumar@amd.com>
(cherry picked from commit 72cdb20)

---------

Co-authored-by: Lakshmi Kumar <lakshmi.kumar@amd.com>
Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs-only Skips most non-documentation CI for this PR documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants