update readme

.github/workflows/python-package-conda.yml

@@ -0,0 +1,34 @@
+name: Python Package using Conda
+
+on: [push]
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 5
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.10'
+    - name: Add conda to system path
+      run: |
+        # $CONDA is an environment variable pointing to the root of the miniconda directory
+        echo $CONDA/bin >> $GITHUB_PATH
+#     - name: Install dependencies
+#       run: |
+#         conda env update --file environment.yml --name base
+#     - name: Lint with flake8
+#       run: |
+#         conda install flake8
+#         # stop the build if there are Python syntax errors or undefined names
+#         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+#         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+#         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        conda install pytest
+#        pytest

README.md

@@ -1,14 +1,38 @@
-# Crossloc3D release
-ICCV 2023: CrossLoc3D: Aerial-Ground Cross-Source 3D Place Recognition 
+# CrossLoc3D: Aerial-Ground Cross-Source 3D Place Recognition (Accepted by ICCV 2023)
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/rayguan97/crossloc3d/.github%2Fworkflows%2Fpython-package-conda.yml)
+[![GitHub Repo stars](https://img.shields.io/github/stars/rayguan97/crossloc3d)](https://github.com/rayguan97/crossloc3d/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/rayguan97/crossloc3d)](https://github.com/rayguan97/crossloc3d/network)
+[![GitHub issues](https://img.shields.io/github/issues/rayguan97/crossloc3d)](https://github.com/rayguan97/crossloc3d/issues)
+[![GitHub](https://img.shields.io/github/license/rayguan97/crossloc3d)](https://github.com/rayguan97/crossloc3d/blob/master/LICENSE)
 
-[CS-Campus3D Dataset](https://drive.google.com/file/d/1rFwfK3LxjMQnzlG_v_73dk63KyphnNjy/view?usp=sharing)
 
+This is the code base for:
+
+[CrossLoc3D: Aerial-Ground Cross-Source 3D Place Recognition](https://arxiv.org/abs/2303.17778).
+<br> Tianrui Guan, Aswath Muthuselvam, Montana Hoover, Xijun Wang, Jing Liang, Adarsh Jagan Sathyamoorthy, Damon Conover, Dinesh Manocha
+
+
+The CS-Campus3D Dataset can be accessed [here](https://drive.google.com/file/d/1rFwfK3LxjMQnzlG_v_73dk63KyphnNjy/view?usp=sharing).
+
+
+If you find this project useful in your research, please cite our work:
+
+```latex
+@InProceedings{Guan_2023_ICCV,
+    author    = {Guan, Tianrui and Muthuselvam, Aswath and Hoover, Montana and Wang, Xijun and Liang, Jing and Sathyamoorthy, Adarsh Jagan and Conover, Damon and Manocha, Dinesh},
+    title     = {CrossLoc3D: Aerial-Ground Cross-Source 3D Place Recognition},
+    booktitle = {Proceedings of the IEEE/CVF International Conference on Computer Vision (ICCV)},
+    month     = {October},
+    year      = {2023},
+}
+
+```
 
 # Setting up Environment
 
+```
 conda create -n crossloc python=3.7 pandas tensorboard numpy -c conda-forge
 conda activate crossloc
-
 conda install pytorch=1.9.1 torchvision cudatoolkit=11.1 -c pytorch -c nvidia
 
 
@@ -24,12 +48,8 @@ pip install pyexr pyntcloud
 
 
 cd MinkowskiEngine
-
-
 python setup.py install --blas_include_dirs=${CONDA_PREFIX}/include --blas=openblas
-
-
-
+```
 
 # Dataset
 
@@ -39,9 +59,10 @@ python setup.py install --blas_include_dirs=${CONDA_PREFIX}/include --blas=openb
 Follow instruction of this [repo](https://github.com/mikacuy/pointnetvlad) or download benchmark_datasets.zip from [here](https://drive.google.com/drive/folders/1Wn1Lvvk0oAkwOUwR0R6apbrekdXAUg7D) and put /benchmark_datasets folder in /data folder.
 
 
-Run:
+```
 python ./datasets/preprocess/generate_training_tuples_baseline.py
 python ./datasets/preprocess/generate_test_sets.py
+```
 
 
 ## CS-Campus3D (Ours)
@@ -51,4 +72,11 @@ Download data [here](https://drive.google.com/file/d/1rFwfK3LxjMQnzlG_v_73dk63Ky
 
 # Training
 
+```
 python main.py ./configs/<config_file>.py
+```
+
+
+# Checkpoint
+
+