Docs/#1 english document #20

hayato-m126 · 2022-10-24T08:53:35Z

Types of PR

New Features

Description

add English document

How to review this PR

mkdocs serve
# then access to localhost:8000

Others

closes: #1

lukasgeiter/mkdocs-awesome-pages-plugin#58

kielczykowski-rai · 2022-10-25T07:16:14Z

I will review the PR today 👀

kielczykowski-rai

Most of the changes are rather stylistic, but I leave the final decision to include them in the repository to you. The documentation is extensive, and I proposed some improvements which I hope will contribute to better reception of the tool and documentation itself. 🙇‍♂️

I know there are a lot of comments, but it is possible to include all the wanted changes in one commit by using the Add suggestion to batch option on GitHub.

docs/index.en.md

docs/introduction/index.en.md

docs/introduction/overview.en.md

docs/use_case/performance_diag.en.md

hayato-m126 · 2022-10-28T02:23:36Z

Thanks for the review.
I will check the suggested revisions.

markdown style: "code", "emphasis" correct grammar errors Co-authored-by: Michał Kiełczykowski <88498438+kielczykowski-rai@users.noreply.github.com>

Co-authored-by: Michał Kiełczykowski <88498438+kielczykowski-rai@users.noreply.github.com>

kielczykowski-rai

I have re-reviewed the PR. All changes seem to be reasonable.

I left a couple of conversations unresolved to attract attention to the Quick Demo section, which you proposed to be implemented.

hayato-m126 · 2022-11-02T11:33:51Z

@kielczykowski-rai

I have ported the documentation that I had already submitted to autoware-documentation to this repository.

https://github.com/tier4/driving_log_replayer/tree/docs/%231-english-document/docs/quick_start

The PR for autoware-doucmentaiton is now just a link to this repository.

https://github.com/autowarefoundation/autoware-documentation/pull/217/files

hayato-m126 · 2022-11-02T11:41:57Z

The content that was created for autoware-documentation was added as quick_start.
This has changed the chapter structure.

index
quick_start
overview
scenario_format
result_format
use_case

kielczykowski-rai

I have tested the example autoware use case once again and have left some comments regarding the execution of the commands in setup.

I have run the localization evaluation example, and the Tests seem to fail. The produced result can be found below:

<< show test result >>
test case 1 / 1 : use case: sample
--------------------------------------------------
TestResult: Failed
ReliabilityError: Convergence: NotTested Reliability: NVTL Sequential NG Count: 10 (Total Test: 256)

kielczykowski-rai · 2022-11-03T08:32:17Z

docs/quick_start/setup.en.md

+   The same maps as in planning-simulation are used, so if you have already downloaded them, you do not need to do this step.
+
+   ```bash
+   gdown -O ~/autoware_map/sample-map-planning.zip 'https://docs.google.com/uc?export=download&id=1499_nsbUbIeturZaDj7jhUownh5fvXHd'


this command assumes that the ~/autoware_map directory exists when downloading the file. Please mention it above the commands or add mkdir ~/autoware_map command before

kielczykowski-rai · 2022-11-03T08:32:22Z

docs/quick_start/setup.en.md

+   The driving_log_replayer tutorial uses the same dataset, so this step is not necessary if you have already downloaded it from other evaluation.
+
+   ```bash
+   gdown -O ~/driving_log_replayer_data/sample_dataset.tar.zst 'https://docs.google.com/uc?export=download&id=1UjMWZj5Yc55O7BZiGHa0ikZGhwmcfPiS'


this command assumes that the ~/driving_log_replayer_data directory exists when downloading the file. Please mention it above the commands or add mkdir ~/driving_log_replayer_data command before

this google drive hyperlink seems not to download the actual file. It is empty in my case. I needed to download it manually through web browser

I think you may have been caught in google drive's daily api limit.

When I ran it in my environment it worked correctly as follows.
11/4 2:55 UTC

❯ gdown -O ~/driving_log_replayer_data/sample_dataset.tar.zst 'https://docs.google.com/uc?export=download&id=1UjMWZj5Yc55O7BZiGHa0ikZGhwmcfPiS' Downloading... From: https://docs.google.com/uc?export=download&id=1UjMWZj5Yc55O7BZiGHa0ikZGhwmcfPiS To: /home/hyt/driving_log_replayer_data/sample_dataset.tar.zst 100%|██████████████████████████████████████| 3.28G/3.28G [01:38<00:00, 33.2MB/s]

docs/quick_start/setup.en.md

docs/quick_start/installation.en.md

Co-authored-by: Michał Kiełczykowski <88498438+kielczykowski-rai@users.noreply.github.com>

hayato-m126 · 2022-11-04T05:52:54Z

@kielczykowski-rai
Thank you for reporting.

<< show test result >>
test case 1 / 1 : use case: sample
--------------------------------------------------
TestResult: Failed
ReliabilityError: Convergence: NotTested Reliability: NVTL Sequential NG Count: 10 (Total Test: 256)

This result happens when ndt is not convered.
This can be caused by CPU load conditions or other reasons.

In this case, you will see the following warning in the terminal.

[ndt_scan_matcher-36] [WARN] [1667540698.508454926] [localization.pose_estimator.ndt_scan_matcher]: Nearest Voxel Transformation Likelihood is below the threshold. Score: 1.840985, Threshold: 2.300000
[ndt_scan_matcher-36] [WARN] [1667540698.508579569] [localization.pose_estimator.ndt_scan_matcher]: Not Converged

I built the latest versions of galactic and humble in my environment to check the operation, and it was working fine.

Signed-off-by: Hayato Mizushima <hayato-m126@users.noreply.github.com>

hayato-m126 added 23 commits October 20, 2022 16:08

docs: add mkdocs i18n

fdc2fda

docs: page in i18n

2d31218

lukasgeiter/mkdocs-awesome-pages-plugin#58

docs: add files

eb4bad9

docs: introduction

3868192

docs: introduction preparation

7b87c3b

docs: introduction

690f3ba

docs: update

5a12c67

docs: update scenario format

247f9b8

docs: update scenario format

9e6d83c

docs: result format

33be7da

docs: result format

f7af890

chore: git mv

499a0de

docs: add use_case english

36ee686

docs: update localization

8efe69f

docs: update localization

3dc4fa1

docs: update obstacle_segmentation

dbb6c6a

docs: update obstacle_segmentation

6a5c7ee

docs: update perception

4bbe9ce

docs: update perception.en.md

af507ee

docs: update performance_diag

1f2fd38

docs: update performance_diag.en.md

f672c81

chore: update index.en.md

f9e4f2f

fix: pre-commit

9f64f48

hayato-m126 requested a review from a team October 25, 2022 05:13

kielczykowski-rai reviewed Oct 27, 2022

View reviewed changes

hayato-m126 and others added 3 commits October 28, 2022 14:09

Apply suggestions from code review

522104c

markdown style: "code", "emphasis" correct grammar errors Co-authored-by: Michał Kiełczykowski <88498438+kielczykowski-rai@users.noreply.github.com>

Apply suggestions from code review

aa0a1b5

Co-authored-by: Michał Kiełczykowski <88498438+kielczykowski-rai@users.noreply.github.com>

docs: fix typo

eac3212

hayato-m126 added 16 commits October 31, 2022 20:36

docs: obstacle segmentation point cloud error hz

07e65de

docs: Example usage flow

8e4cad9

fix: lint, format

1c97f07

fix: spell check

479c7a9

docs: mkdocs setting

5143496

docs: quick start

4d716f5

fix: markdown lint

532d38a

chore: git mv

3e8547d

docs: update overview

a398880

docs: update run.md

2cb23fa

chore: git mv

f906ffa

chore: git mv

1aca954

docs: update setup

5fd1f47

fix: yaml lint

dd6c145

fix: sample directory path

de2c263

docs: update

1bbf3af

kielczykowski-rai self-requested a review November 2, 2022 09:44

kielczykowski-rai approved these changes Nov 2, 2022

View reviewed changes

kielczykowski-rai reviewed Nov 3, 2022

View reviewed changes

hayato-m126 and others added 4 commits November 4, 2022 11:49

docs: add make map directory

43ea9e5

docs: make dataset directory

55cbfd0

Update docs/quick_start/setup.en.md

8793cd6

Co-authored-by: Michał Kiełczykowski <88498438+kielczykowski-rai@users.noreply.github.com>

Update docs/quick_start/installation.en.md

1ab0f9f

Co-authored-by: Michał Kiełczykowski <88498438+kielczykowski-rai@users.noreply.github.com>

docs: delete unnecessary sentence

538dea1

hayato-m126 merged commit fc10331 into develop Nov 4, 2022

hayato-m126 deleted the docs/#1-english-document branch November 4, 2022 08:04

hayato-m126 added a commit that referenced this pull request Sep 5, 2024

fix: url (#20)

4da4d6a

Signed-off-by: Hayato Mizushima <hayato-m126@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs/#1 english document #20

Docs/#1 english document #20

hayato-m126 commented Oct 24, 2022 •

edited

Loading

kielczykowski-rai commented Oct 25, 2022

kielczykowski-rai left a comment

hayato-m126 commented Oct 28, 2022

kielczykowski-rai left a comment

hayato-m126 commented Nov 2, 2022

hayato-m126 commented Nov 2, 2022

kielczykowski-rai left a comment

kielczykowski-rai Nov 3, 2022

hayato-m126 Nov 4, 2022

kielczykowski-rai Nov 3, 2022

hayato-m126 Nov 4, 2022

hayato-m126 Nov 4, 2022 •

edited

Loading

hayato-m126 commented Nov 4, 2022

Docs/#1 english document #20

Docs/#1 english document #20

Conversation

hayato-m126 commented Oct 24, 2022 • edited Loading

Types of PR

Description

How to review this PR

Others

kielczykowski-rai commented Oct 25, 2022

kielczykowski-rai left a comment

Choose a reason for hiding this comment

hayato-m126 commented Oct 28, 2022

kielczykowski-rai left a comment

Choose a reason for hiding this comment

hayato-m126 commented Nov 2, 2022

hayato-m126 commented Nov 2, 2022

kielczykowski-rai left a comment

Choose a reason for hiding this comment

kielczykowski-rai Nov 3, 2022

Choose a reason for hiding this comment

hayato-m126 Nov 4, 2022

Choose a reason for hiding this comment

kielczykowski-rai Nov 3, 2022

Choose a reason for hiding this comment

hayato-m126 Nov 4, 2022

Choose a reason for hiding this comment

hayato-m126 Nov 4, 2022 • edited Loading

Choose a reason for hiding this comment

hayato-m126 commented Nov 4, 2022

hayato-m126 commented Oct 24, 2022 •

edited

Loading

hayato-m126 Nov 4, 2022 •

edited

Loading