レビュ指摘対応：Annofab点群形式（KITIIベース）と紛れもないような表記に変更

kurusugawa-computer · Oct 2, 2022 · 1c8a215 · 1c8a215
1 parent d0058c8
commit 1c8a215
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/anno3d/app.py b/anno3d/app.py
@@ -566,7 +566,7 @@ def upload_scene(
         annofab_endpoint: Optional[str] = env_annofab_endpoint,
     ) -> None:
         """
-        Annofab点群形式のファイル群をAnnoFabにアップロードします
+        Annofab点群形式（KITTIベース）のファイル群をAnnoFabにアップロードします
 
         Args:
             annofab_id: AnnoFabのユーザID。指定が無い場合は環境変数`ANNOFAB_USER_ID`の値を採用する
@@ -635,7 +635,7 @@ def upload_scene_to_s3(
         annofab_endpoint: Optional[str] = env_annofab_endpoint,
     ) -> None:
         """
-        Annofab点群形式のファイル群をAWS S3にアップロードした上で、3dpc-editorに登録します。
+        Annofab点群形式（KITTIベース）のファイル群をAWS S3にアップロードした上で、3dpc-editorに登録します。
 
         Args:
             s3_path: 登録先のS3パス（ex: "{bucket}/{key}"）
@@ -746,7 +746,7 @@ def make_scene(
         sensor_height: Optional[float] = None,
     ) -> None:
         """
-        Annofab点群形式のファイル群を3dpc-editorに登録可能なファイル群に変換します。
+        Annofab点群形式（KITTIベース）のファイル群を3dpc-editorに登録可能なファイル群に変換します。
         annofabのプライベートストレージを利用する場合にこのコマンドを利用します。
         Args:
             scene_path: scene.metaファイルのファイルパス or scene.metaファイルの存在するディレクトリパス or kitti形式ディレクトリ

diff --git a/anno3d/file_paths_loader.py b/anno3d/file_paths_loader.py
@@ -45,7 +45,7 @@ def __init__(self, scene_path: Path):
 
     def load(self) -> List[FilePaths]:
         """
-        Annofab点群形式のファイルを読み込む.
+        Annofab点群形式（KITTIベース）のファイルを読み込む.
 
         Args:
             scene_path: 読み込み対象パス。　以下の何れかとなる

diff --git a/docs/user_guide/command_sample.md b/docs/user_guide/command_sample.md
@@ -491,9 +491,9 @@ anno3d project upload_kitti_data \
   --force
 ```
 
-### データの投入（Annofab点群形式）
+### データの投入（Annofab点群形式（KITTIベース））
 
-`project upload_scene` により、[Annofab点群形式](annofab_point_cloud_format.md)のファイル群をAnnoFabへ登録できます。
+`project upload_scene` により、[Annofab点群形式（KITTIベース）](annofab_point_cloud_format.md)のファイル群をAnnoFabへ登録できます。
 あわせて `--upload_kind` を指定することで、タスク作成やアノテーション登録も同時に行うことができます。
 
 
@@ -502,13 +502,13 @@ anno3d project upload_kitti_data \
 ```
 $ anno3d project upload_scene -- --help | cat
 NAME
-    app.py project upload_scene - Annofab点群形式のファイル群をAnnoFabにアップロードします
+    app.py project upload_scene - Annofab点群形式（KITTIベース）のファイル群をAnnoFabにアップロードします
 
 SYNOPSIS
     app.py project upload_scene PROJECT_ID SCENE_PATH <flags>
 
 DESCRIPTION
-    Annofab点群形式のファイル群をAnnoFabにアップロードします
+    Annofab点群形式（KITTIベース）のファイル群をAnnoFabにアップロードします
 
 POSITIONAL ARGUMENTS
     PROJECT_ID
@@ -562,7 +562,7 @@ anno3d project upload_scene \
 
 ### データの投入（S3プライベートストレージ）
 
-`project upload_scene_to_s3` により、[Annofab点群形式](annofab_point_cloud_format.md)のファイル群を、AWS S3にアップロードした上でAnnoFabへ登録できます。
+`project upload_scene_to_s3` により、[Annofab点群形式（KITTIベース）](annofab_point_cloud_format.md)のファイル群を、AWS S3にアップロードした上でAnnoFabへ登録できます。
 
 事前にAWSの認証情報を設定しておく必要があります。[boto3 : Credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) を参考にしてください。
 
@@ -572,13 +572,13 @@ anno3d project upload_scene \
 ```
 $ anno3d project upload_scene_to_s3 -- --help | cat
 NAME
-    app.py project upload_scene_to_s3 - Annofab点群形式のファイル群をAWS S3にアップロードした上で、3dpc-editorに登録します。
+    app.py project upload_scene_to_s3 - Annofab点群形式（KITTIベース）のファイル群をAWS S3にアップロードした上で、3dpc-editorに登録します。
 
 SYNOPSIS
     app.py project upload_scene_to_s3 PROJECT_ID SCENE_PATH S3_PATH <flags>
 
 DESCRIPTION
-    Annofab点群形式のファイル群をAWS S3にアップロードした上で、3dpc-editorに登録します。
+    Annofab点群形式（KITTIベース）のファイル群をAWS S3にアップロードした上で、3dpc-editorに登録します。
 
 POSITIONAL ARGUMENTS
     PROJECT_ID
@@ -686,20 +686,20 @@ $ anno3d local make_kitti_data \
 
 ### make_scene
 
-Annofab点群形式のデータを元に出力する場合は、`anno3d local make_scene`コマンドを利用してください。
+Annofab点群形式（KITTIベース）のデータを元に出力する場合は、`anno3d local make_scene`コマンドを利用してください。
 
 #### ヘルプ
 
 ```
 $ anno3d local make_scene -- --help | cat
 NAME
-    app.py local make_scene - Annofab点群形式のファイル群を3dpc-editorに登録可能なファイル群に変換します。 annofabのプライベートストレージを利用する場合にこのコマンドを利用します。
+    app.py local make_scene - Annofab点群形式（KITTIベース）のファイル群を3dpc-editorに登録可能なファイル群に変換します。 annofabのプライベートストレージを利用する場合にこのコマンドを利用します。
 
 SYNOPSIS
     app.py local make_scene SCENE_PATH OUTPUT_DIR <flags>
 
 DESCRIPTION
-    Annofab点群形式のファイル群を3dpc-editorに登録可能なファイル群に変換します。 annofabのプライベートストレージを利用する場合にこのコマンドを利用します。
+    Annofab点群形式（KITTIベース）のファイル群を3dpc-editorに登録可能なファイル群に変換します。 annofabのプライベートストレージを利用する場合にこのコマンドを利用します。
 
 POSITIONAL ARGUMENTS
     SCENE_PATH