Add pipeline tag and library name, include Github README content
#1
by
nielsr
HF Staff
- opened
README.md
CHANGED
@@ -1,5 +1,167 @@
|
|
1 |
---
|
2 |
license: apache-2.0
|
|
|
|
|
3 |
---
|
4 |
|
5 |
-
Pre-trained models for [Open-CD](https://github.com/likyoo/open-cd).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
license: apache-2.0
|
3 |
+
pipeline_tag: image-segmentation
|
4 |
+
library_name: OpenMMLab
|
5 |
---
|
6 |
|
7 |
+
Pre-trained models for [Open-CD](https://github.com/likyoo/open-cd).
|
8 |
+
|
9 |
+
<div align="center">
|
10 |
+
<img src="resources/opencd-logo.png" width="600"/>
|
11 |
+
</div>
|
12 |
+
|
13 |
+
------
|
14 |
+
|
15 |
+
<div align="center">
|
16 |
+
<a href="https://arxiv.org/abs/2407.15317"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Farxiv.org%2Fabs%2F2407.15317&count_bg=%23FF0000&title_bg=%23555555&icon=arxiv.svg&icon=&icon_color=%23E7E7E7&title=Technical+Report&edge_flat=false"/></a>
|
17 |
+
<a href="https://github.com/likyoo/open-cd"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Flikyoo%2Fopen-cdA&count_bg=%2379C83D&title_bg=%23555555&icon=github.svg&icon_color=%23E7E7E7&title=Github&edge_flat=false"/></a>
|
18 |
+
<a href="https://huggingface.co/likyoo/Open-CD_Model_Zoo"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fhuggingface.co%2Flikyoo%2FOpen-CD_Model_Zoo&count_bg=%23684BD3&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=%F0%9F%A4%97%20Hugging%20Face&edge_flat=false"/></a>
|
19 |
+
</div>
|
20 |
+
|
21 |
+
## Introduction
|
22 |
+
Open-CD is an open source change detection toolbox based on a series of open source general vision task tools.
|
23 |
+
|
24 |
+
|
25 |
+
## News
|
26 |
+
- 4/11/2025 - [MTKD](https://github.com/circleLZY/MTKD-CD) method and [JL1-CD](https://github.com/circleLZY/MTKD-CD) dataset are supported. Open-CD Technical Report is updated to v1.1.
|
27 |
+
- 7/23/2024 - **Open-CD Technical Report v1.0 is released on [arXiv](https://arxiv.org/abs/2407.15317), thanks to all contributors! Feel free to join us!** 💥💥💥
|
28 |
+
- 6/29/2024 - [ChangeStar](https://github.com/Z-Zheng/ChangeStar) and [FarSeg](https://github.com/Z-Zheng/FarSeg) are supported.
|
29 |
+
- 6/20/2024 - We launch the **[Open-CD Technical Report Plan](https://github.com/likyoo/open-cd/tree/main/projects/open-cd_technical_report)**, don't hesitate to join us!!! 💥💥💥
|
30 |
+
- 6/17/2024 - [CGNet](https://github.com/ChengxiHAN/CGNet-CD) is supported.
|
31 |
+
- 2/10/2024 - Open-CD is upgraded to v1.1.0. [BAN](https://github.com/likyoo/BAN), [TTP](https://github.com/KyanChen/TTP) and [LightCDNet](https://github.com/NightSongs/LightCDNet) is supported. The inference API is added.
|
32 |
+
- 4/21/2023 - Open-CD v1.0.0 is released in 1.x branch, based on OpenMMLab 2.0 ! PyTorch 2.0 is also supported ! Enjoy it !
|
33 |
+
- 3/14/2023 - Open-CD is upgraded to v0.0.3. Semantic Change Detection (SCD) is supported !
|
34 |
+
- 11/17/2022 - Open-CD is upgraded to v0.0.2, requiring a higher version of the MMSegmentation dependency.
|
35 |
+
- 9/28/2022 - The code, pre-trained models and logs of [ChangerEx](https://github.com/likyoo/open-cd/tree/main/configs/changer) are available. :yum:
|
36 |
+
- 9/20/2022 - Our paper [Changer: Feature Interaction is What You Need for Change Detection](https://arxiv.org/abs/2209.08290) is available!
|
37 |
+
- 7/30/2022 - Open-CD is publicly available!
|
38 |
+
|
39 |
+
## Benchmark and model zoo
|
40 |
+
|
41 |
+
Supported toolboxes:
|
42 |
+
|
43 |
+
- [x] [OpenMMLab Toolkits](https://github.com/open-mmlab)
|
44 |
+
- [x] [pytorch-image-models](https://github.com/rwightman/pytorch-image-models)
|
45 |
+
- [ ] ...
|
46 |
+
|
47 |
+
Supported change detection model:
|
48 |
+
(_The code of some models are borrowed directly from their official repositories._)
|
49 |
+
|
50 |
+
- [x] [FC-EF (ICIP'2018)](configs/fcsn)
|
51 |
+
- [x] [FC-Siam-diff (ICIP'2018)](configs/fcsn)
|
52 |
+
- [x] [FC-Siam-conc (ICIP'2018)](configs/fcsn)
|
53 |
+
- [x] [STANet (RS'2020)](configs/stanet)
|
54 |
+
- [x] [IFN (ISPRS'2020)](configs/ifn)
|
55 |
+
- [x] [SNUNet (GRSL'2021)](configs/snunet)
|
56 |
+
- [x] [BiT (TGRS'2021)](configs/bit)
|
57 |
+
- [x] [ChangeStar (ICCV'2021)](configs/changestar)
|
58 |
+
- [x] [ChangeFormer (IGARSS'22)](configs/changeformer)
|
59 |
+
- [x] [TinyCD (NCA'2023)](configs/tinycd)
|
60 |
+
- [x] [Changer (TGRS'2023)](configs/changer)
|
61 |
+
- [x] [HANet (JSTARS'2023)](configs/hanet)
|
62 |
+
- [x] [TinyCDv2 (Under Review)](configs/tinycd_v2)
|
63 |
+
- [x] [LightCDNet (GRSL'2023)](configs/lightcdnet)
|
64 |
+
- [x] [CGNet (JSTARS'2023)](configs/cgnet)
|
65 |
+
- [x] [BAN (TGRS'2024)](configs/ban)
|
66 |
+
- [x] [TTP (arXiv'2023)](configs/ttp)
|
67 |
+
- [x] [MTKD (arXiv'2025)](configs/mtkd)
|
68 |
+
- [ ] ...
|
69 |
+
|
70 |
+
Supported datasets: | [Descriptions](https://github.com/wenhwu/awesome-remote-sensing-change-detection)
|
71 |
+
- [x] [LEVIR-CD](https://justchenhao.github.io/LEVIR/)
|
72 |
+
- [x] [WHU-CD](https://study.rsgis.whu.edu.cn/pages/download/building_dataset.html)
|
73 |
+
- [x] [S2Looking](https://github.com/S2Looking/Dataset)
|
74 |
+
- [x] [SVCD](https://drive.google.com/file/d/1GX656JqqOyBi_Ef0w65kDGVto-nHrNs9/edit)
|
75 |
+
- [x] [DSIFN](https://github.com/GeoZcx/A-deeply-supervised-image-fusion-network-for-change-detection-in-remote-sensing-images/tree/master/dataset)
|
76 |
+
- [x] [CLCD](https://github.com/liumency/CropLand-CD)
|
77 |
+
- [x] [RSIPAC](https://engine.piesat.cn/ai/autolearning/index.html#/dataset/detail?key=8f6c7645-e60f-42ce-9af3-2c66e95cfa27)
|
78 |
+
- [x] [SECOND](http://www.captain-whu.com/PROJECT/)
|
79 |
+
- [x] [Landsat](https://figshare.com/articles/figure/Landsat-SCD_dataset_zip/19946135/1)
|
80 |
+
- [x] [BANDON](https://github.com/fitzpchao/BANDON)
|
81 |
+
- [x] [JL1-CD](https://github.com/circleLZY/MTKD-CD)
|
82 |
+
- [ ] ...
|
83 |
+
|
84 |
+
## Usage
|
85 |
+
|
86 |
+
[Docs](https://github.com/open-mmlab/mmsegmentation/tree/master/docs)
|
87 |
+
|
88 |
+
Please refer to [get_started.md](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/en/get_started.md#installation) in mmseg.
|
89 |
+
|
90 |
+
A Colab tutorial is also provided. You may directly run on [Colab](https://colab.research.google.com/drive/1puZY5R8fwlL6um6pHbgbM1NTYZUXdK2J?usp=sharing). (thanks to [@Agustin](https://github.com/AgustinNormand) for this demo) [](https://colab.research.google.com/drive/1puZY5R8fwlL6um6pHbgbM1NTYZUXdK2J?usp=sharing)
|
91 |
+
|
92 |
+
#### Install
|
93 |
+
|
94 |
+
```
|
95 |
+
# Install OpenMMLab Toolkits as Python packages
|
96 |
+
pip install -U openmim
|
97 |
+
mim install mmengine
|
98 |
+
mim install "mmcv>=2.0.0"
|
99 |
+
mim install "mmpretrain>=1.0.0rc7"
|
100 |
+
pip install "mmsegmentation>=1.2.2"
|
101 |
+
pip install "mmdet>=3.0.0"
|
102 |
+
```
|
103 |
+
```
|
104 |
+
git clone https://github.com/likyoo/open-cd.git
|
105 |
+
cd open-cd
|
106 |
+
pip install -v -e .
|
107 |
+
```
|
108 |
+
For more details, please see [here](https://github.com/likyoo/open-cd/blob/main/docs/install.md).
|
109 |
+
|
110 |
+
#### Train
|
111 |
+
```
|
112 |
+
python tools/train.py configs/changer/changer_ex_r18_512x512_40k_levircd.py --work-dir ./changer_r18_levir_workdir
|
113 |
+
```
|
114 |
+
|
115 |
+
#### Test
|
116 |
+
```
|
117 |
+
# get .png results
|
118 |
+
python tools/test.py configs/changer/changer_ex_r18_512x512_40k_levircd.py changer_r18_levir_workdir/latest.pth --show-dir tmp_infer
|
119 |
+
# get metrics
|
120 |
+
python tools/test.py configs/changer/changer_ex_r18_512x512_40k_levircd.py changer_r18_levir_workdir/latest.pth
|
121 |
+
```
|
122 |
+
|
123 |
+
#### Infer
|
124 |
+
Please refer [inference](https://github.com/likyoo/open-cd/blob/main/docs/inference.md) doc.
|
125 |
+
|
126 |
+
|
127 |
+
## Citation
|
128 |
+
|
129 |
+
If you find this project useful in your research, please cite:
|
130 |
+
|
131 |
+
```bibtex
|
132 |
+
@article{opencd,
|
133 |
+
title = {{Open-CD}: A Comprehensive Toolbox for Change Detection},
|
134 |
+
author = {Li, Kaiyu and Jiang, Jiawei and Codegoni, Andrea and Han, Chengxi and Deng, Yupeng and Chen, Keyan and Zheng, Zhuo and
|
135 |
+
Chen, Hao and Zou, Zhengxia and Shi, Zhenwei and Fang, Sheng and Meng, Deyu and Wang, Zhi and Cao, Xiangyong},
|
136 |
+
journal= {arXiv preprint arXiv:2407.15317},
|
137 |
+
year={2024}
|
138 |
+
}
|
139 |
+
```
|
140 |
+
You might also consider citing:
|
141 |
+
|
142 |
+
```bibtex
|
143 |
+
@ARTICLE{10438490,
|
144 |
+
author={Li, Kaiyu and Cao, Xiangyong and Meng, Deyu},
|
145 |
+
journal={IEEE Transactions on Geoscience and Remote Sensing},
|
146 |
+
title={A New Learning Paradigm for Foundation Model-based Remote Sensing Change Detection},
|
147 |
+
year={2024},
|
148 |
+
volume={},
|
149 |
+
number={},
|
150 |
+
pages={1-1},
|
151 |
+
keywords={Adaptation models;Task analysis;Data models;Computational modeling;Feature extraction;Transformers;Tuning;Change detection;foundation model;visual tuning;remote sensing image processing;deep learning},
|
152 |
+
doi={10.1109/TGRS.2024.3365825}}
|
153 |
+
|
154 |
+
@ARTICLE{10129139,
|
155 |
+
author={Fang, Sheng and Li, Kaiyu and Li, Zhe},
|
156 |
+
journal={IEEE Transactions on Geoscience and Remote Sensing},
|
157 |
+
title={Changer: Feature Interaction is What You Need for Change Detection},
|
158 |
+
year={2023},
|
159 |
+
volume={61},
|
160 |
+
number={},
|
161 |
+
pages={1-11},
|
162 |
+
doi={10.1109/TGRS.2023.3277496}}
|
163 |
+
```
|
164 |
+
|
165 |
+
## License
|
166 |
+
|
167 |
+
Open-CD is released under the Apache 2.0 license.
|