hkayabilisim commited on
Commit
db0ce92
·
verified ·
1 Parent(s): 9847c99

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -20
README.md CHANGED
@@ -33,7 +33,7 @@ configs:
33
  # Welcome to the KATE-CD Dataset
34
  Welcome to the home page of Kahramanmaraş Türkiye Earthquake-Change Detection Dataset (KATE-CD). If you are reading this README, you are probably visiting one of the following places to learn more about **KATE-CD Dataset** and the associated study "*Earthquake Damage Assessment with SAMCD: A Change Detection Approach for VHR Images*", to be presented in 17th International Conference on Joint Urban Remote Sensing ([JURSE 2025](https://2025.ieee-jurse.org)).
35
 
36
- * [Code Ocean Capsule](https://codeocean.com/capsule/3747729) in [Open Science Library](https://codeocean.com/explore)
37
  * [GitHub Repository](https://github.com/cscrs/kate-cd)
38
  * [HuggingFace](https://huggingface.co/datasets/cscrs/kate-cd)
39
 
@@ -55,9 +55,9 @@ To integrate with the change detection frameworks, the dataset was structured in
55
  The dataset is published on three platforms: CodeOcean, GitHub and HuggingFace. The purpose of CodeOcean is to provide data, codes and the computing instructions to reproduce the results. CodeOcean uses the term *capsule* to define the collection of everything needed to reproduce the results. Depending on your goal and your time constraints, CodeOcean provide two alternatives to run the capsule and obtain the results: via Open Science Library or Capsule Export.
56
 
57
  ### Open Science Library
58
- If you visit this capsule via [Open Science Library](https://codeocean.com/explore) developed by [Code Ocean](https://codeocean.com), then you should be able to see the published results in the results folder of the capsule. Code Ocean has an internal publishing process to verify that on each run the capsule will produce the same results. So, if you are in a hurry, or don't bother running the capsule again, then you can take a look at the published results and check the codes and data in the capsule.
59
 
60
- If you want to run the capsule and produce results by yourself, then all you have to do is to click "Reproducible Run" button in the capsule page. The [Open Science Library](https://codeocean.com/explore) will run the capsule from the scratch and produce the results.
61
 
62
  ### Capsule Export
63
  If you would like to use your own computing resources for reproduction, then you can export the capsule via "Capsule"--> "Export" menu to your working environment. Please make sure to check "Include Data" option while exporting. After extracting the export file, you should follow the instructions in "REPRODUCING.md". For the sake of completeness, we mention the procesures here.
@@ -66,33 +66,34 @@ If you would like to use your own computing resources for reproduction, then you
66
  - [Docker Community Edition (CE)](https://www.docker.com/community-edition)
67
 
68
  #### Building the environment
69
- In your terminal, navigate to the folder where you've extracted the capsule and execute the following command:
70
- ```shell
71
- cd environment && docker build . --tag e24e05d9-fd7f-4584-878b-4f19e31b750c; cd ..
72
- ```
73
-
74
- This step will recreate the environment (i.e., the Docker image) locally, fetching and installing any required dependencies in the process. If any external resources have become unavailable for any reason, the environment will fail to build.
75
 
76
  ### Running the capsule to reproduce the results
77
  In your terminal, navigate to the folder where you've extracted the capsule and execute the following command, adjusting parameters as needed:
78
  ```shell
79
- docker run --platform linux/amd64 --rm \
80
  --workdir /code \
81
  --volume "$PWD/data":/data \
82
  --volume "$PWD/code":/code \
83
  --volume "$PWD/results":/results \
84
- e24e05d9-fd7f-4584-878b-4f19e31b750c bash run
85
  ```
86
 
87
  ## Published results
88
  In the results folder of the CodeOcean capsule, you can reach the pre-computed outputs of the code or you can generate them from scratch with single-click in CodeOcean. In either case, these outputs correspond to the published content in the manuscript. The mapping between capsule results and the content in the manuscript is as follows:
89
 
90
- Code CodeOcean Manuscript
91
- ------------ ---------------- ----------
92
- predictions.py val_scores.txt Table II
93
- evaluate.py train_scores.txt
94
- test_scores.txt
95
  ---------------------------------------------
 
 
 
 
 
96
 
97
  ## For Developers
98
  ### Differences between the platforms:
@@ -112,6 +113,10 @@ To open the capsule in VSCode via [Development Containers](https://containers.de
112
 
113
  ~~~bash
114
  # CodeOcean git repository
 
 
 
 
115
  $ git clone https://git.codeocean.com/capsule-3747729.git
116
  ~~~
117
  or
@@ -131,7 +136,7 @@ The Parquet files in the HuggingFace repository are updated via:
131
  $ python utils/hf_update_db.py
132
 
133
  ### Relative vs Absolute paths
134
- We use relative paths to locate the data files in the code to achieve compatibility between different working environments. In this way, the same codes and data structure can be used without any change if one tries to run the capsule on [Open Science Library](https://codeocean.com/explore) or local development environment.
135
 
136
  The only requirement of relative-path approach is to run Python codes within the **code** folder similar to this:
137
  ~~~bash
@@ -141,11 +146,9 @@ $ python predictions.py
141
  This approach also fits to the way how CodeOcean runs the capsule.
142
 
143
  ### Reproducibility results folder
144
- If you visit [Open Science Library](https://codeocean.com/explore), you will see that published results are always populated under **results** folder. This is a special folder CodeOcean uses to store the outputs likes PDFs, PNGs, or ordinary text outputs. Therefore, in CodeOcean capsules **results** folder is not included in *git* structure. So, when you pull or export a CodeOcean capsule, you won't see this folder. Whenever you create an output, you should create **results** folder and put the outputs under it. For the same reason, you should not include it to git.
145
 
146
 
147
 
148
 
149
 
150
-
151
-
 
33
  # Welcome to the KATE-CD Dataset
34
  Welcome to the home page of Kahramanmaraş Türkiye Earthquake-Change Detection Dataset (KATE-CD). If you are reading this README, you are probably visiting one of the following places to learn more about **KATE-CD Dataset** and the associated study "*Earthquake Damage Assessment with SAMCD: A Change Detection Approach for VHR Images*", to be presented in 17th International Conference on Joint Urban Remote Sensing ([JURSE 2025](https://2025.ieee-jurse.org)).
35
 
36
+ * [Code Ocean Capsule](https://doi.org/10.24433/CO.3747729.v1) in [Open Science Library](https://codeocean.com/explore/82765786-a936-438c-a75a-84e2817294c5)
37
  * [GitHub Repository](https://github.com/cscrs/kate-cd)
38
  * [HuggingFace](https://huggingface.co/datasets/cscrs/kate-cd)
39
 
 
55
  The dataset is published on three platforms: CodeOcean, GitHub and HuggingFace. The purpose of CodeOcean is to provide data, codes and the computing instructions to reproduce the results. CodeOcean uses the term *capsule* to define the collection of everything needed to reproduce the results. Depending on your goal and your time constraints, CodeOcean provide two alternatives to run the capsule and obtain the results: via Open Science Library or Capsule Export.
56
 
57
  ### Open Science Library
58
+ If you visit [this capsule](https://doi.org/10.24433/CO.3747729.v1) via [Open Science Library](https://codeocean.com/explore/82765786-a936-438c-a75a-84e2817294c5) developed by [Code Ocean](https://codeocean.com), then you should be able to see the published results in the results folder of the capsule. Code Ocean has an internal publishing process to verify that on each run the capsule will produce the same results. So, if you are in a hurry, or don't bother running the capsule again, then you can take a look at the published results and check the codes and data in the capsule.
59
 
60
+ If you want to run the capsule and produce results by yourself, then all you have to do is to click "Reproducible Run" button in the capsule page. The [Open Science Library](https://codeocean.com/explore/82765786-a936-438c-a75a-84e2817294c5) will run the capsule from the scratch and produce the results.
61
 
62
  ### Capsule Export
63
  If you would like to use your own computing resources for reproduction, then you can export the capsule via "Capsule"--> "Export" menu to your working environment. Please make sure to check "Include Data" option while exporting. After extracting the export file, you should follow the instructions in "REPRODUCING.md". For the sake of completeness, we mention the procesures here.
 
66
  - [Docker Community Edition (CE)](https://www.docker.com/community-edition)
67
 
68
  #### Building the environment
69
+ This capsule has been published and its environment has been archived and made available on Code Ocean's Docker registry:
70
+ `registry.codeocean.com/published/82765786-a936-438c-a75a-84e2817294c5:v1`
 
 
 
 
71
 
72
  ### Running the capsule to reproduce the results
73
  In your terminal, navigate to the folder where you've extracted the capsule and execute the following command, adjusting parameters as needed:
74
  ```shell
75
+ docker run --platform linux/amd64 --rm --gpus all \
76
  --workdir /code \
77
  --volume "$PWD/data":/data \
78
  --volume "$PWD/code":/code \
79
  --volume "$PWD/results":/results \
80
+ registry.codeocean.com/published/82765786-a936-438c-a75a-84e2817294c5:v1 bash run
81
  ```
82
 
83
  ## Published results
84
  In the results folder of the CodeOcean capsule, you can reach the pre-computed outputs of the code or you can generate them from scratch with single-click in CodeOcean. In either case, these outputs correspond to the published content in the manuscript. The mapping between capsule results and the content in the manuscript is as follows:
85
 
86
+ Code Outputs Manuscript
87
+ ------------ ---------------- ----------
88
+ predictions.py val_scores.txt Table II
89
+ evaluate.py train_scores.txt
90
+ test_scores.txt
91
  ---------------------------------------------
92
+ visualization.py val_plots.pdf Figure 2
93
+ train_plots.pdf
94
+ test_plots.pdf
95
+ ---------------------------------------------
96
+
97
 
98
  ## For Developers
99
  ### Differences between the platforms:
 
113
 
114
  ~~~bash
115
  # CodeOcean git repository
116
+ # There are two git repos in CodeOcean.
117
+ # (1) Repo of the published capsule (https://git.codeocean.com/capsule-9061546.git)
118
+ # (2) Repo of the original capsule (https://git.codeocean.com/capsule-3747729.git)
119
+ # Here, we are using the git repo of the original capsule
120
  $ git clone https://git.codeocean.com/capsule-3747729.git
121
  ~~~
122
  or
 
136
  $ python utils/hf_update_db.py
137
 
138
  ### Relative vs Absolute paths
139
+ We use relative paths to locate the data files in the code to achieve compatibility between different working environments. In this way, the same codes and data structure can be used without any change if one tries to run the capsule on [Open Science Library](https://codeocean.com/explore/82765786-a936-438c-a75a-84e2817294c5) or local development environment.
140
 
141
  The only requirement of relative-path approach is to run Python codes within the **code** folder similar to this:
142
  ~~~bash
 
146
  This approach also fits to the way how CodeOcean runs the capsule.
147
 
148
  ### Reproducibility results folder
149
+ If you visit [Open Science Library](https://codeocean.com/explore/82765786-a936-438c-a75a-84e2817294c5), you will see that published results are always populated under **results** folder. This is a special folder CodeOcean uses to store the outputs likes PDFs, PNGs, or ordinary text outputs. Therefore, in CodeOcean capsules **results** folder is not included in *git* structure. So, when you pull or export a CodeOcean capsule, you won't see this folder. Whenever you create an output, you should create **results** folder and put the outputs under it. For the same reason, you should not include it to git.
150
 
151
 
152
 
153
 
154