code release

.gitignore

@@ -0,0 +1,148 @@
+# my stuff
+magicdrive-log
+magicdrive-log/*
+*.png
+*.jpg
+perception/cross_view_transformers/splits/*
+tmp
+tmp/*
+.tmp/*
+cvt-outputs/*
+pretrained/*
+
+!perception/cross_view_transformers/splits/scene_gen.txt
+!.gitkeep
+
+
+# vscode
+.vscode/*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

README.MD

@@ -18,9 +18,74 @@ In MagicDrive, we employ two strategies (cross-attention and additive encoder br
 
 ![image-20231011165634648](./assets/overview.png)
 
+## TODO
+
+- [x] [config](configs/exp/224x400.yaml) and [pretrained weight](https://mycuhk-my.sharepoint.com/:u:/g/personal/1155157018_link_cuhk_edu_hk/ERiu-lbAvq5IkODTscFXYPUBpVYVDbwjHchDExBlPfeQ0w?e=8YaDM0) for base resolution (224x400)
+- [x] demo for base resolution (224x400)
+- [ ] train and test code release
+- [ ] config and pretrained weight for high resolution
+- [ ] train and test code for CVT and BEVFusion
+
+## Getting Started
+
+### Environment Setup
+
+Clone this repo with submodules
+
+```bash
+git clone --recursive https://github.com/cure-lab/MagicDrive.git
+```
+
+The code is tested with `Pytorch==1.10.2` and `cuda 10.2` on V100 servers. To setup the python environment, follow:
+
+```bash
+cd ${ROOT}
+pip install -r requirements/dev.txt
+```
+
+We opt to install the source code for the following packages, with `cd ${FOLDER}; pip install .`
+
+```bash
+# install third-party
+third_party/
+├── bevfusion -> based on db75150
+├── diffusers -> based on v0.17.1 (afcca39)
+└── xformers  -> based on v0.0.19 (8bf59c9), optional
+```
+
+see [note about our xformers](doc/xformers.md)
+
+Setup default configuration for accelearte with
+```bash
+accelerate config
+```
+
+Our default log directory is `${ROOT}/magicdrive-log`. Please be prepared.
+
+### Pretrained Weights
+
+Our training are based on [stable-diffusion-v1-5](https://huggingface.co/runwayml/stable-diffusion-v1-5). We assume you put them at `${ROOT}/pretrained/` as follows:
+
+```bash
+{ROOT}/pretrained/stable-diffusion-v1-5/
+├── text_encoder
+├── tokenizer
+├── unet
+├── vae
+└── ...
+```
+
 ## Street-view Generation with MagicDrive
 
-Coming soon.
+Download our pretrained weight for MagicDrive from [onedrive](https://mycuhk-my.sharepoint.com/:u:/g/personal/1155157018_link_cuhk_edu_hk/ERiu-lbAvq5IkODTscFXYPUBpVYVDbwjHchDExBlPfeQ0w?e=8YaDM0) and put it in `${ROOT}/pretrained/`
+
+**Run our demo**
+
+```bash
+cd ${ROOT}
+python demo/run.py resume_from_checkpoint=magicdrive-log/SDv1.5mv-rawbox_2023-09-07_18-39_224x400
+```
+The generated images will be located in `magicdrive-log/test`. More information can be find in [demo doc](demo/readme.md).
 
 ## Train MagicDrive
 
@@ -47,11 +112,18 @@ More results can be found in the main paper.
 ## Cite Us
 
 ```bibtex
-@article{gao2023magicdrive,
-  title={MagicDrive: Street View Generation with Diverse 3D Geometry Control},
+@inproceedings{gao2023magicdrive,
+  title={{MagicDrive}: Street View Generation with Diverse 3D Geometry Control},
   author={Gao, Ruiyuan and Chen, Kai and Xie, Enze and Hong, Lanqing and Li, Zhenguo and Yeung, Dit-Yan and Xu, Qiang},
-  journal={arXiv preprint arXiv:2310.02601},
-  year={2023}
+  booktitle = {International Conference on Machine Learning},
+  year={2024}
 }
 ```
 
+## Credit
+
+We adopt following open-sourced projects:
+
+- [bevfusion](https://github.com/mit-han-lab/bevfusion): dataloader to handle 3d bounding boxes and BEV map
+- [diffusers](https://github.com/huggingface/diffusers): framework to train stable diffusion
+- [xformers](https://github.com/facebookresearch/xformers): accelerator for attention mechanism

configs/accelerator/default.yaml

@@ -0,0 +1,3 @@
+gradient_accumulation_steps: 1
+mixed_precision: fp16
+report_to: tensorboard

configs/config.yaml

@@ -0,0 +1,27 @@
+defaults:
+  - _self_
+  - model: SDv1.5mv_rawbox
+  - dataset: Nuscenes_cache
+  - accelerator: default
+  - runner: default
+
+task_id: "0.0.0"
+log_root_prefix: ./magicdrive-log
+projname: ${model.name}
+hydra:
+  run:
+    dir: ${log_root_prefix}/${projname}_${now:%Y-%m-%d}_${now:%H-%M}_${task_id}
+  output_subdir: hydra
+
+try_run: false
+debug: false
+log_root: ???
+init_method: env://
+seed: 42
+fix_seed_within_batch: false
+
+resume_from_checkpoint: null
+resume_reset_scheduler: false
+validation_only: false
+# num_gpus: 1
+# num_workers: 4