Skip to content

Commit d041032

Browse files
committed
docs: update document
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
1 parent 7c21bba commit d041032

2 files changed

Lines changed: 36 additions & 17 deletions

File tree

docs/tutorials/initialize.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,42 @@
22

33
---
44

5-
`Tier4` class expects the following dataset directly structure:
6-
7-
```shell
8-
data/tier4/
9-
├── annotation ...contains `*.json` files.
10-
├── data
11-
│   ├── CAM_BACK
12-
│   ├── CAM_BACK_LEFT
13-
│   ├── CAM_BACK_RIGHT
14-
│   ├── CAM_FRONT
15-
│   ├── CAM_FRONT_LEFT
16-
│   ├── CAM_FRONT_RIGHT
17-
│   ├── LIDAR_CONCAT
18-
│   └── ...Other sensor channels
19-
...
20-
```
5+
`Tier4` class expects both following dataset directly structure with or without `<VERSION>` directory:
6+
7+
- With `<VERSION>` directory:
8+
9+
```shell
10+
data/tier4/
11+
└── <VERSION> ...version number
12+
├── annotation ...contains `*.json` files
13+
├── data
14+
│   ├── CAM_BACK
15+
│   ├── CAM_BACK_LEFT
16+
│   ├── CAM_BACK_RIGHT
17+
│   ├── CAM_FRONT
18+
│   ├── CAM_FRONT_LEFT
19+
│   ├── CAM_FRONT_RIGHT
20+
│   ├── LIDAR_CONCAT
21+
│   └── ...Other sensor channels
22+
...
23+
```
24+
25+
- Without `<VERSION>` directory:
26+
27+
```shell
28+
data/tier4/
29+
├── annotation ...contains `*.json` files
30+
├── data
31+
│   ├── CAM_BACK
32+
│   ├── CAM_BACK_LEFT
33+
│   ├── CAM_BACK_RIGHT
34+
│   ├── CAM_FRONT
35+
│   ├── CAM_FRONT_LEFT
36+
│   ├── CAM_FRONT_RIGHT
37+
│   ├── LIDAR_CONCAT
38+
│   └── ...Other sensor channels
39+
...
40+
```
2141

2242
You can initialize a `Tier4` instance as follows:
2343

t4_devkit/tier4.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,6 @@ def __init__(self, data_root: str, verbose: bool = True) -> None:
8484
"""Load database and creates reverse indexes and shortcuts.
8585
8686
Args:
87-
version (str): Directory name of database json files.
8887
data_root (str): Path to the root directory of dataset.
8988
verbose (bool, optional): Whether to display status during load.
9089

0 commit comments

Comments
 (0)