ROS1 documentation updates and enhancements #316

tsampazk · 2022-09-22T12:01:23Z

Main changes in projects/opendr_ws/src/perception/README.md include:
- Added a prerequisite section describing common prerequisites between nodes and notes section for general information
- Separated the node documentation in sections depending on their input type, similar to the contents in projects/opendr_ws/README.md
- Added argument information about all currently updated nodes that use argparse
Did some restructuring on projects/opendr_ws/README.md to match the order of the projects/opendr_ws/src/perception/README.md content
Added a class ID table for semantic segmentation bisenet both in the ROS documentation and the tool's documentation
~~Added some TODO comments on not yet updated nodes, see tracker issue [Tracker] ROS1 nodes updates and fixes #305.~~

tsampazk · 2022-09-22T12:13:59Z

Hey @stefaniapedrazzi! Right now from my end the PR is ready for review, but the docs are 'incomplete' as some nodes are not yet updated. Do you think we can go ahead and review/merge this and change the docs for remaining nodes as soon as they are updated or keep this as draft and update it simultaneously?

stefaniapedrazzi · 2022-09-26T08:58:24Z

Given that the list of nodes that still needs to be updated should be already listed in #305, I think that we can review and merge this PR.

stefaniapedrazzi

Changes are fine!

There is just one link pointing to a file that doesn't exist.
And maybe the very long lines containing multiple sentences may be split.

projects/opendr_ws/src/perception/README.md

tsampazk · 2022-09-26T09:53:18Z

Thank you for the review!

And maybe the very long lines containing multiple sentences may be split.

Sorry about that, i am not exactly sure what convention we are following in the docs, regarding the long lines. I applied the fixes suggested.

stefaniapedrazzi · 2022-09-26T09:59:30Z

Initially I tried to insist on having one sentence per line on the documentation for MD filed because it is easier to read and review the sources.
But this doesn't seem very intuitive for all the other partners and at the end it is not a very important issue.

So it is preferable to not split sentences on different lines even if they are very long and it is ok to have multiple sentences per line if they are not too long.
But if there are long sentences I would say it is better to write them on a new line.

stefaniapedrazzi

Thank you!

tsampazk · 2022-09-26T10:22:25Z

Initially I tried to insist on having one sentence per line on the documentation for MD filed because it is easier to read and review the sources. But this doesn't seem very intuitive for all the other partners and at the end it is not a very important issue.

So it is preferable to not split sentences on different lines even if they are very long and it is ok to have multiple sentences per line if they are not too long. But if there are long sentences I would say it is better to write them on a new line.

Alright TYVM for the explanation!

tsampazk · 2022-12-01T12:48:08Z

I have made any updates needed for #364 locally (also merged that branch into this, resolving the conflicts) and i am going to push them as soon as #364 is merged, as i think this will make the procedure as clean as possible and everything ends up merging in develop smoothly.

tsampazk · 2022-12-07T14:56:58Z

The updates in the ROS docs are complete now, PR is ready for review.

ad-daniel

That's quite the improvement, very clear and complete, thank you!
Only a few suggestions

projects/opendr_ws/README.md

projects/opendr_ws/src/opendr_perception/README.md

…riable

tsampazk · 2022-12-08T12:52:45Z

Thanks @ad-daniel for the review! Should we add the test-tools label now that the install.sh file is modified?

ad-daniel · 2022-12-08T12:54:27Z

sure doesn't hurt

ad-daniel

We can wait for the tests, but it looks good to me, thanks!

ad-daniel · 2022-12-08T14:40:12Z

no need to wait the tests again, once they pass we sync the branch and remove the label

passalis

Also looks good to me as well! Thank you!

* Added prerequisites section for common prerequisites across nodes * Overhauled the dataset nodes section and added RGB nodes section * Rearranged the listed node links * General rearrangement and input sections * Additional modifications and pose estimation section * Section renaming for consistency * Some rearrangement in contents list to match the order * Fall detection doc and moved dataset nodes to bottom * Face det, reco, 2d object detection overhaul and todo notes * Added a class id table on sem segmentation doc * Panoptic and semantic segmentation overhaul * Fix long lines as per suggestions * Fix long lines as per suggestions * Removed commented pose estimation usage suggestion * Update video HAR docs foro ROS node * Updated the video human activity recognition section and some other minor fixes * Fixed italics showing as block * Removed redundant line separators after headers * Removed redundant horizontal line from RGBD header * Added notes for output visualization and updated pose estimation docs * Added missing space in pose estimation docs * Updates on formatting for all other applicable nodes' docs and minor fixes * More detailed ros setup instructions * Added skipping of workspace build step * Updated RGBD hand gesture recognition ros node doc * Updated speech command recognition ros node doc and some minor fixes * Updated heart anomaly detection ros node doc * Reordered audio section and added RGB + Audio section * Added audiovisual emotion reco missing doc and reordered audio section * Added link to csv file with classes-ids for activity recognition * Added link to csv file with class-ids for activity recognition * Minor improvements * Several minor fixes and landmark-based facial expression recognition * Skeleton-based human action recognition and minor fixes * Moved fair mot in rgb input section * Completed ROS1 docs * Updates on default values for FairMOT ros node class ctor * Fixed duplicate shortcut on deepsort ros node argparse * Fixed missing shortcut on rgbd hand gesture reco ros node argparse * Added "opendr_" to data gen package and "_node" to the node file name * Renamed package to "opendr_perception" and added "_node" to scripts * Applied fixes to yolov5 * Added "opendr_" to planning package * Added "opendr_" to bridge package * Added "opendr_" to simulation package * Fixed old version of torch in pip_requirements.txt * Renamed ros bridge package doc * Updated based on new names and some minor modifications * Fixed list numbers * Merge clean-up * Added a new notes item with a node diagram and explanation * Minor formatting fixes in the diagram section * Fixed step X dot consistency * Fixed step X dot consistency * Added detached & in instructions for running stuff * Removed apt ros package installation instructions * Added some additional required ros packages and made ROS version a variable Co-authored-by: LukasHedegaard <[email protected]> Co-authored-by: ad-daniel <[email protected]>

tsampazk added 12 commits September 15, 2022 18:46

Added prerequisites section for common prerequisites across nodes

22c4ef9

Overhauled the dataset nodes section and added RGB nodes section

5e9db80

Rearranged the listed node links

c0684dc

General rearrangement and input sections

9f23346

Additional modifications and pose estimation section

a18f4b5

Section renaming for consistency

c5e403f

Some rearrangement in contents list to match the order

b267be0

Merge branch 'develop' into ros-nodes-docs

6597ad8

Fall detection doc and moved dataset nodes to bottom

c3bf14c

Face det, reco, 2d object detection overhaul and todo notes

42d0f00

Added a class id table on sem segmentation doc

12ab09c

Panoptic and semantic segmentation overhaul

a02f6ab

tsampazk added the documentation Improvements or additions to documentation label Sep 22, 2022

tsampazk self-assigned this Sep 22, 2022

Merge branch 'develop' into ros-nodes-docs

61669df

tsampazk marked this pull request as ready for review September 26, 2022 08:59

tsampazk requested review from passalis, omichel, ad-daniel and stefaniapedrazzi as code owners September 26, 2022 08:59

stefaniapedrazzi requested changes Sep 26, 2022

View reviewed changes

tsampazk added 3 commits September 26, 2022 12:43

Fix long lines as per suggestions

6f35459

Fix long lines as per suggestions

95b0ba6

Removed commented pose estimation usage suggestion

fdd730c

stefaniapedrazzi previously approved these changes Sep 26, 2022

View reviewed changes

tsampazk added 6 commits December 1, 2022 16:13

Updated based on new names and some minor modifications

18fc19c

Fixed list numbers

e2abdaa

Merge develop into ros-nodes-docs

4895d22

Merge clean-up

4df42a6

Added a new notes item with a node diagram and explanation

7f94fc5

Minor formatting fixes in the diagram section

6ef83b9

Merge branch 'develop' into ros-nodes-docs

ac7d1e8

ad-daniel requested changes Dec 8, 2022

View reviewed changes

tsampazk added 7 commits December 8, 2022 11:42

Merge branch 'develop' into ros-nodes-docs

3a02797

Fixed step X dot consistency

a75279e

Fixed step X dot consistency

863e1a1

Added detached & in instructions for running stuff

d2cc449

Removed apt ros package installation instructions

366a758

Added some additional required ros packages and made ROS version a va…

efcd727

…riable

Merge branch 'develop' into ros-nodes-docs

f88e2b3

tsampazk requested a review from ad-daniel December 8, 2022 12:50

ad-daniel added test sources Run style checks test tools Test the toolkit methods labels Dec 8, 2022

ad-daniel approved these changes Dec 8, 2022

View reviewed changes

Merge branch 'develop' into ros-nodes-docs

ed90865

ad-daniel removed the test tools Test the toolkit methods label Dec 8, 2022

passalis approved these changes Dec 9, 2022

View reviewed changes

ad-daniel merged commit a57fb9f into develop Dec 11, 2022

ad-daniel deleted the ros-nodes-docs branch December 11, 2022 17:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ROS1 documentation updates and enhancements #316

ROS1 documentation updates and enhancements #316

tsampazk commented Sep 22, 2022 •

edited

Loading

tsampazk commented Sep 22, 2022

stefaniapedrazzi commented Sep 26, 2022

stefaniapedrazzi left a comment

tsampazk commented Sep 26, 2022

stefaniapedrazzi commented Sep 26, 2022 •

edited

Loading

stefaniapedrazzi left a comment •

edited

Loading

tsampazk commented Sep 26, 2022

tsampazk commented Dec 1, 2022

tsampazk commented Dec 7, 2022

ad-daniel left a comment

tsampazk commented Dec 8, 2022

ad-daniel commented Dec 8, 2022

ad-daniel left a comment

ad-daniel commented Dec 8, 2022

passalis left a comment

ROS1 documentation updates and enhancements #316

ROS1 documentation updates and enhancements #316

Conversation

tsampazk commented Sep 22, 2022 • edited Loading

tsampazk commented Sep 22, 2022

stefaniapedrazzi commented Sep 26, 2022

stefaniapedrazzi left a comment

Choose a reason for hiding this comment

tsampazk commented Sep 26, 2022

stefaniapedrazzi commented Sep 26, 2022 • edited Loading

stefaniapedrazzi left a comment • edited Loading

Choose a reason for hiding this comment

tsampazk commented Sep 26, 2022

tsampazk commented Dec 1, 2022

tsampazk commented Dec 7, 2022

ad-daniel left a comment

Choose a reason for hiding this comment

tsampazk commented Dec 8, 2022

ad-daniel commented Dec 8, 2022

ad-daniel left a comment

Choose a reason for hiding this comment

ad-daniel commented Dec 8, 2022

passalis left a comment

Choose a reason for hiding this comment

tsampazk commented Sep 22, 2022 •

edited

Loading

stefaniapedrazzi commented Sep 26, 2022 •

edited

Loading

stefaniapedrazzi left a comment •

edited

Loading