Skip to content

AM62A edgeai docs support #286

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

AM62A edgeai docs support #286

wants to merge 2 commits into from

Conversation

jeevantelukula
Copy link
Collaborator

@github-actions GitHub Actions
Copy link

github-actions bot commented May 9, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:1: (SEVERE/4) Problems with "include" directive path:
source/devices/AM62AX/edgeai/getting_started.rst:7: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:117: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:117: (ERROR/3) (bash) `docker save --output <pre_built_docker_image.tar>'
source/edgeai/docker_environment.rst:128: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:128: (ERROR/3) (bash) `docker load --input <pre_built_docker_image.tar>'
source/edgeai/docker_environment.rst:140: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:140: (ERROR/3) (bash) `docker rmi <image_name/ID>'
source/edgeai/docker_environment.rst:156: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:156: (ERROR/3) (bash) `docker rm <container_ID>'
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/edgeai_ecosystem.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/measure_perf.rst:67: (ERROR/3) (bash) syntax error near unexpected token `('
source/edgeai/measure_perf.rst:67: (ERROR/3) (bash) `CPU: mpu1_0: TOTAL LOAD = 43.81 % ( HWI =  0.74 %, SWI =  0.24 % )'
source/edgeai/measure_perf.rst:97: (ERROR/3) (bash) syntax error near unexpected token `|'
source/edgeai/measure_perf.rst:97: (ERROR/3) (bash) `|element                      latency     out-latancy     out-fps    frames    |'
source/edgeai/measure_perf.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/sdk_components.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/development_flow.rst:50: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:50: (ERROR/3) (bash) `<PSDK-RTOS path>#./psdk_rtos/scripts/setup_psdk_rtos.sh'
source/edgeai/development_flow.rst:91: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:91: (ERROR/3) (bash) `<PSDK-RTOS path>#sudo ./psdk_rtos/scripts/mk-linux-card.sh /dev/sda'
source/edgeai/development_flow.rst:103: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:103: (ERROR/3) (bash) `<PSDK-RTOS path>#./psdk_rtos/scripts/install_to_sd_card.sh'
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".
source/edgeai/sdk_overview.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/inference_models.rst:183: (ERROR/3) (bash) syntax error near unexpected token `|'
source/edgeai/inference_models.rst:183: (ERROR/3) (bash) `|'
source/edgeai/inference_models.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/configuration_file.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/sample_apps.rst:1: (SEVERE/4) Problems with "include" directive path:

@github-actions GitHub Actions
Copy link

github-actions bot commented May 9, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:117: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:117: (ERROR/3) (bash) `docker save --output <pre_built_docker_image.tar>'
source/edgeai/docker_environment.rst:128: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:128: (ERROR/3) (bash) `docker load --input <pre_built_docker_image.tar>'
source/edgeai/docker_environment.rst:140: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:140: (ERROR/3) (bash) `docker rmi <image_name/ID>'
source/edgeai/docker_environment.rst:156: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:156: (ERROR/3) (bash) `docker rm <container_ID>'
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/measure_perf.rst:65: (ERROR/3) (bash) syntax error near unexpected token `('
source/edgeai/measure_perf.rst:65: (ERROR/3) (bash) `CPU: mpu1_0: TOTAL LOAD = 43.81 % ( HWI =  0.74 %, SWI =  0.24 % )'
source/edgeai/measure_perf.rst:95: (ERROR/3) (bash) syntax error near unexpected token `|'
source/edgeai/measure_perf.rst:95: (ERROR/3) (bash) `|element                      latency     out-latancy     out-fps    frames    |'
source/edgeai/development_flow.rst:50: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:50: (ERROR/3) (bash) `<PSDK-RTOS path>#./psdk_rtos/scripts/setup_psdk_rtos.sh'
source/edgeai/development_flow.rst:91: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:91: (ERROR/3) (bash) `<PSDK-RTOS path>#sudo ./psdk_rtos/scripts/mk-linux-card.sh /dev/sda'
source/edgeai/development_flow.rst:103: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:103: (ERROR/3) (bash) `<PSDK-RTOS path>#./psdk_rtos/scripts/install_to_sd_card.sh'
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".
source/edgeai/inference_models.rst:181: (ERROR/3) (bash) syntax error near unexpected token `|'
source/edgeai/inference_models.rst:181: (ERROR/3) (bash) `|'

@jeevantelukula
Copy link
Collaborator Author

StaticRocket
StaticRocket previously requested changes May 9, 2025
View reviewed changes
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

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

Got some concerns about the current structure, but otherwise I think this will be useful.

@cshilwant
Copy link
Member

@jeevantelukula hope you are planning to address the errors by rstcheck as well - #286 (comment)

@cshilwant
Copy link
Member

+ @sadik-smd @jsuhaas22 for reviews

@github-actions GitHub Actions
Copy link

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

StaticRocket
StaticRocket reviewed May 14, 2025
View reviewed changes
@github-actions GitHub Actions
Copy link

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

cshilwant
cshilwant previously requested changes May 21, 2025
View reviewed changes
@github-actions GitHub Actions
Copy link

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

@jeevantelukula
feat: Add support for AM62A edgeai docs
8b895dc 
Till now the edgeai sdk docs for AM62A are maintained in a
bitbucket repository. This commit adds support for building
the edgeai docs for AM62A.

The edgeai docs can be built similar to processor-sdk-docs but
with OS as edgeai.

Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>
@jeevantelukula
feat: Add building AM62A edgeai docs in github workflow
a65efd0 
Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>
@github-actions GitHub Actions
Copy link

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

@cshilwant cshilwant dismissed StaticRocket’s stale review May 23, 2025 13:59

author has updated the PR

@cshilwant cshilwant dismissed their stale review May 23, 2025 13:59

author has updated the PR

@cshilwant cshilwant self-requested a review May 23, 2025 14:01
@cshilwant
Copy link
Member

@StaticRocket @sadik-smd to re-review

cshilwant
cshilwant approved these changes May 23, 2025
View reviewed changes
Copy link
Member

@cshilwant cshilwant left a comment

Choose a reason for hiding this comment

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

I see more cleanups but we can do that as a follow up PRs.
For now, this LGTM to enable bleeding EdgeAI SDK docs for AM62A on github.io

glneo
glneo reviewed May 23, 2025
View reviewed changes
source/edgeai/edgeai_dataflows.rst

.. _pub_edgeai_optiflow_data_flow:

OpTIFlow
Copy link
Contributor

Choose a reason for hiding this comment

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

The following examples are not OpTIFlow based, these are all GStreamer pipelines, this heading should be GStreamer. Same for Python/C++ apps section below which should probably be removed as it is a duplicate of this section.

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

@glneo glneo glneo left review comments

@cshilwant cshilwant cshilwant approved these changes

@praneethbajjuri praneethbajjuri Awaiting requested review from praneethbajjuri praneethbajjuri is a code owner

@uditkumarti uditkumarti Awaiting requested review from uditkumarti uditkumarti is a code owner

@aniket-l aniket-l Awaiting requested review from aniket-l aniket-l is a code owner

@VeeruPrudhvi VeeruPrudhvi Awaiting requested review from VeeruPrudhvi VeeruPrudhvi is a code owner

@StaticRocket StaticRocket Awaiting requested review from StaticRocket StaticRocket is a code owner

@sadik-smd sadik-smd Awaiting requested review from sadik-smd

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jeevantelukula @cshilwant @glneo @StaticRocket @sadik-smd