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

Prepare documentation #57

Merged

Conversation

spolifroni-amd
Copy link
Contributor

No description provided.

@spolifroni-amd spolifroni-amd added documentation Improvements or additions to documentation ci:docs-only labels Sep 26, 2024
@spolifroni-amd spolifroni-amd marked this pull request as draft September 26, 2024 19:29
@spolifroni-amd spolifroni-amd changed the title Updated the readme file to point to the official documentation Prepare documentation Sep 26, 2024
@AryanSalmanpour AryanSalmanpour force-pushed the spolifroni-amd/prepare-documentation branch from 6b14eda to 8e2c4db Compare October 2, 2024 16:14
Copy link

@lpaoletti lpaoletti left a comment

Choose a reason for hiding this comment

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

No need to worry about redirects for deleted files as this isn't public yet

README.md Show resolved Hide resolved
Copy link

@lpaoletti lpaoletti left a comment

Choose a reason for hiding this comment

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

Why aren't they any changes to the Using topic.
This topic is oddly structured.
Numbered procedures?

@AryanSalmanpour AryanSalmanpour force-pushed the spolifroni-amd/prepare-documentation branch from 8c9f929 to 32c42eb Compare October 10, 2024 19:52
@spolifroni-amd spolifroni-amd marked this pull request as ready for review October 15, 2024 20:44
docs/how-to/using-rocjpeg.rst Outdated Show resolved Hide resolved
docs/install/rocjpeg-prerequisites.rst Outdated Show resolved Hide resolved
docs/install/rocjpeg-prerequisites.rst Outdated Show resolved Hide resolved
Copy link
Member

@AryanSalmanpour AryanSalmanpour left a comment

Choose a reason for hiding this comment

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

in the main README.md file, please remove the Documentation section

README.md Outdated Show resolved Hide resolved
@AryanSalmanpour AryanSalmanpour merged commit 31610c7 into ROCm:develop Oct 22, 2024
1 check passed
vamovsik pushed a commit that referenced this pull request Nov 19, 2024
* Update Samples (#52)

* Add support for ROI decode on MI300 (#53)

* Add support for ROI decode on MI300

* Add ROI decode support for batched decoding

* clean up

* clean up

* Fix a typo and update sample's readme

* Increase the output image size for rgb and rgb_planar (#54)

* Increase the output image size for rgb and rgb_planar to avoi

* code clean up

* rename yuv to yuv_planar for the output format (#55)

* update docs (#56)

* update docs

* remove extra line

* clean up

* Optimize the memory pool allocation bso that its size doesn't exceed the max_pool_size_ (#58)

* update clang path per packaging (#59)

* Fix few typos in the header file - no functional changes (#61)

* Add code owners for the rocJPEG (#62)

* Add code owners for the rocJPEG

* code clean up

* Exclude YUV 4:4:0 for RGB format conversion in VCN on MI300, as it is not supported. Instead, use HIP kernels. (#63)

* Update the libva requirement (#64)

* Update the libva requirement

* clean up READNE file

* Prepare documentation (#57)

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* fixed missing space

* All changes asked for in the PR except the Destroy Handles part.

* separated creating and destroying handles; added a destroying handles section; added links to hipmalloc() and hipfree()

* removed the installation and build sections so that it doesn't conflict/go out of sync with the official doc

* putting readme back the way it was, minus documentation section

* changed some wording around hipFree()

* Find the minimum supported libva version 1.16 when building rocJPEG (#65)

* Fix a typo in README/Docs (#66)

* use a single context for decoding (#68)

* increase the mem_alignment size used for output image rgb memory allocation (#70)

---------

Co-authored-by: Lakshmi Kumar <[email protected]>
Co-authored-by: spolifroni-amd <[email protected]>
spolifroni-amd added a commit to spolifroni-amd/rocJPEG that referenced this pull request Dec 5, 2024
* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* fixed missing space

* All changes asked for in the PR except the Destroy Handles part.

* separated creating and destroying handles; added a destroying handles section; added links to hipmalloc() and hipfree()

* removed the installation and build sections so that it doesn't conflict/go out of sync with the official doc

* putting readme back the way it was, minus documentation section

* changed some wording around hipFree()
spolifroni-amd added a commit that referenced this pull request Dec 5, 2024
* Prepare documentation (#57)

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* fixed missing space

* All changes asked for in the PR except the Destroy Handles part.

* separated creating and destroying handles; added a destroying handles section; added links to hipmalloc() and hipfree()

* removed the installation and build sections so that it doesn't conflict/go out of sync with the official doc

* putting readme back the way it was, minus documentation section

* changed some wording around hipFree()

* Fix a typo in README/Docs (#66)

* Edited the readme and reorganized the toc (#69)

* Edited the readme so that it doesn't duplicate information in the official online docs

* rearranged the toc to match the new structure

* moved Docker section

---------

Co-authored-by: Aryan Salmanpour <[email protected]>
kiritigowda pushed a commit that referenced this pull request Dec 10, 2024
* Update documentation requirements

* Upd doc reqs

* Update RTD yaml

* cherry pick to add documentation (#94)

* Prepare documentation (#57)

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* Updated the readme file to point to the official documentation

* first commit of new documentation structure

* split up and reconfigured Using rocJpeg

* fixed missing space

* All changes asked for in the PR except the Destroy Handles part.

* separated creating and destroying handles; added a destroying handles section; added links to hipmalloc() and hipfree()

* removed the installation and build sections so that it doesn't conflict/go out of sync with the official doc

* putting readme back the way it was, minus documentation section

* changed some wording around hipFree()

* Fix a typo in README/Docs (#66)

* Edited the readme and reorganized the toc (#69)

* Edited the readme so that it doesn't duplicate information in the official online docs

* rearranged the toc to match the new structure

* moved Docker section

---------

Co-authored-by: Aryan Salmanpour <[email protected]>

* Update README.md

---------

Co-authored-by: alexxu-amd <[email protected]>
Co-authored-by: Sam Wu <[email protected]>
Co-authored-by: Aryan Salmanpour <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs-only documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants