Skip to content

AM62A edgeai docs support#286

Merged
jeevantelukula merged 3 commits into
TexasInstruments:masterfrom
jeevantelukula:master
Jun 3, 2025
Merged

AM62A edgeai docs support#286
jeevantelukula merged 3 commits into
TexasInstruments:masterfrom
jeevantelukula:master

Conversation

@jeevantelukula

Copy link
Copy Markdown
Collaborator

@github-actions

github-actions Bot commented May 9, 2025

Copy link
Copy Markdown

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 Bot commented May 9, 2025

Copy link
Copy Markdown

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
Copy Markdown
Collaborator Author

@StaticRocket StaticRocket left a comment

Copy link
Copy Markdown
Member

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.

Comment thread source/devices/AM62AX/edgeai/release_notes.rst
Comment thread source/devices/AM62AX/edgeai/pi_hdr_programming.rst
Comment thread source/edgeai/datasheet/AM62AX/optiflow/optiflow_camera_am62a.csv
Comment thread source/images/edgeai/edge_ai_demos.drawio Outdated
@cshilwant

Copy link
Copy Markdown
Member

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

@cshilwant

Copy link
Copy Markdown
Member

+ @sadik-smd @jsuhaas22 for reviews

@github-actions

Copy link
Copy Markdown

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".

Comment thread source/devices/AM62AX/edgeai/datasheet_tiovx_apps.rst Outdated
Comment thread source/devices/AM62AX/edgeai/datasheet_tiovx_apps.rst Outdated
Comment thread source/devices/AM62AX/edgeai/index.rst Outdated
Comment thread source/devices/AM62AX/edgeai/release_notes_10_00.rst Outdated
@github-actions

Copy link
Copy Markdown

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".

Comment thread source/edgeai/edgeai_ecosystem.rst Outdated
Comment thread source/edgeai/sample_apps.rst
Comment thread source/edgeai/docker_environment.rst
Comment thread source/edgeai/docker_environment.rst
Comment thread source/edgeai/development_flow.rst Outdated
Comment thread source/edgeai/development_flow.rst Outdated
Comment thread source/edgeai/configuration_file.rst Outdated
Comment thread source/edgeai/configuration_file.rst Outdated
Comment thread source/edgeai/configuration_file.rst
Comment thread source/devices/AM62AX/edgeai/test_report.rst Outdated
@github-actions

Copy link
Copy Markdown

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".

@github-actions

Copy link
Copy Markdown

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 stale reviews from StaticRocket and themself May 23, 2025 13:59

author has updated the PR

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

Copy link
Copy Markdown
Member

@StaticRocket @sadik-smd to re-review

cshilwant
cshilwant previously approved these changes May 23, 2025

@cshilwant cshilwant left a comment

Copy link
Copy Markdown
Member

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

Comment thread source/edgeai/edgeai_dataflows.rst
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 <j-sahu@ti.com>
Signed-off-by: Telukula Jeevan Kumar Sahu <j-sahu@ti.com>
Add default owners for AM62A edgeai in component owners list
for PR reviews on AM62A edgeai docs.

Signed-off-by: Telukula Jeevan Kumar Sahu <j-sahu@ti.com>
@github-actions

github-actions Bot commented Jun 2, 2025

Copy link
Copy Markdown

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".

@jeevantelukula jeevantelukula requested a review from cshilwant June 2, 2025 08:46

@StaticRocket StaticRocket left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This should work for now

@jeevantelukula jeevantelukula merged commit 13795bd into TexasInstruments:master Jun 3, 2025
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants