mohamed-boudjoghra commited on
Commit
18f9ec6
1 Parent(s): 5f3418a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +1 -46
README.md CHANGED
@@ -44,57 +44,12 @@ We empirically find that a better performance of matching text prompts to 3D mas
44
  </div>
45
 
46
 
47
- ## Installation guide
48
-
49
- Kindly check [Installation guide](./docs/Installation.md) on how to setup the Conda environment and to download the checkpoints, the pre-computed class agnostic masks, and the ground truth masks.
50
-
51
- ## Data Preparation
52
-
53
- Kindly check [Data Preparation guide](./docs/Data_prep.md) on how to prepare ScanNet200 and Replica datasets.
54
-
55
- ## Results reproducibility
56
-
57
- Kindly use the pre-computed class agnostic masks we shared to reproduce the exact numbers we reported in the paper.
58
-
59
- **Reproduce the results of ScanNet200 with precomputed-masks (using Mask3D)**
60
- ```
61
- python run_evaluation.py --dataset_name scannet200 --path_to_3d_masks "./output/scannet200/scannet200_masks"
62
- ```
63
- **Reproduce the results of ScanNet200 with oracle 3D masks (ground truth 3D masks)**
64
- ```
65
- python run_evaluation.py --dataset_name scannet200 --path_to_3d_masks "./output/scannet200/scannet200_ground_truth_masks" --is_gt
66
- ```
67
- **Reproduce the results of Replica with precomputed-masks (using Mask3D)**
68
- ```
69
- python run_evaluation.py --dataset_name replica --path_to_3d_masks "./output/replica/replica_masks"
70
- ```
71
- **Reproduce the results of Replica with oracle 3D masks (ground truth 3D masks)**
72
- ```
73
- python run_evaluation.py --dataset_name replica --path_to_3d_masks "./output/replica/replica_ground_truth_masks" --is_gt
74
- ```
75
-
76
- You can evaluate without our 3D class-agnostic masks, but this may lead to variability in results due to elements like furthest point sampling that cause randomness in predictions from Mask3D. For consistent results with the ones we report in the paper, we recommend using our pre-computed masks.
77
-
78
- **Reproduce the results of Replica or ScanNet200 without using our pre-computed masks**
79
- ```
80
- python run_evaluation.py --dataset_name $DATASET_NAME
81
- ```
82
-
83
- ## Single scene inference
84
-
85
- ```
86
- from utils import OpenYolo3D
87
-
88
- openyolo3d = OpenYolo3D("$(pwd)/pretrained/config.yaml") #Initialize the model, define the text prompts in the config.
89
- prediction = openyolo3d.predict("$(pwd)/data/replica/office0", 6553.5) #Predict the instance masks and labels (takes around 20 seconds in total).
90
- openyolo3d.save_output_as_ply("$(pwd)/sample/output.ply", True) # Save the ply file for visualization, you can use meshlab to visualize the output scene
91
- ```
92
 
93
  ## Acknoledgments
94
  We would like to thank the authors of <a href="https://github.com/cvg/Mask3D">Mask3D</a> and <a href="https://github.com/AILab-CVC/YOLO-World">YoloWorld</a> for their works which were used for our model.
95
  </div>
96
 
97
- ## BibTeX :pray:
98
  ```
99
  @misc{boudjoghra2024openyolo,
100
  title={Open-YOLO 3D: Towards Fast and Accurate Open-Vocabulary 3D Instance Segmentation},
 
44
  </div>
45
 
46
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
 
48
  ## Acknoledgments
49
  We would like to thank the authors of <a href="https://github.com/cvg/Mask3D">Mask3D</a> and <a href="https://github.com/AILab-CVC/YOLO-World">YoloWorld</a> for their works which were used for our model.
50
  </div>
51
 
52
+ ## BibTeX :
53
  ```
54
  @misc{boudjoghra2024openyolo,
55
  title={Open-YOLO 3D: Towards Fast and Accurate Open-Vocabulary 3D Instance Segmentation},