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

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -7
README.md CHANGED
@@ -30,13 +30,12 @@ configs:
30
  path: data/test-*
31
  ---
32
 
33
-
34
  # Welcome to the KATE-CD Dataset
35
  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)).
36
 
37
  * [Code Ocean Capsule](https://codeocean.com/capsule/3747729) in [Open Science Library](https://codeocean.com/explore)
38
- * [GitHub Repository](https://github.com/hkayabilisim/kate-cd)
39
- * [HuggingFace](https://huggingface.co/datasets/cscsr/kate-cd)
40
 
41
  The **KATE-CD Dataset** and the associated codes and supplementary information are published in three places i.e. CodeOcean, GitHub and HuggingFAce for providing redundancy and extended reach. All of the content uploaded to the three websites are the same except small differences because of platform requirements. The CodeOcean platform is mainly used for reproducibility, whereas GitHub is used to provide git access and hence easy collaboration between **KATE-CD Dataset** developers. Finally HuggingFace provides an easy access to the database where you can run existing models in HuggingFace on KATE-CD without too much effort.
42
 
@@ -99,14 +98,14 @@ In the results folder of the CodeOcean capsule, you can reach the pre-computed o
99
  ### Differences between the platforms:
100
  * CodeOcean is the primary source of the dataset (*data* folder) and the codes (*code* folder).
101
  * GitHub does not contain *data* folder because GitHub is not designed to store and manage large files.
102
- * [HuggingFace dataset](https://huggingface.co/datasets/cscsr/kate-cd) is hosted on an isolated repository with Large File Support (LFS). In this isolated repo, Parquet files of the original *data* folder are served. It also includes a README file with an auto-generated metadata for visual presentation on HuggingFace.
103
 
104
  ### GitHub Access
105
  If you would like to look at the capsule more closely, and build a working development environment then you can use [Development Containers](https://containers.dev/) functionality of VSCode. For this purpose, we created **.devcontainer/devcontainer.json** file under the root folder in the capsule. The purpose of this config file is to tell VSCode the location of the **Dockerfile**. Here, for design purposes, we used the same **Dockerfile** provided by CodeOcean. In this way, we do not interfere the building process in the CodeOcean.
106
 
107
  To open the GitHub repository in DevContainers, you can click the button below. It will open the VSCode in DevContainers mode and fetch the GitHub repository automatically.
108
 
109
- [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/hkayabilisim/kate-cd.git)
110
 
111
  ### CodeOcean Access
112
  To open the capsule in VSCode via [Development Containers](https://containers.dev/), you first need to download the capsule. There are two ways: either you can use the capsule export, or you can pull the capsule from git repository. We recommend using git. You can use either CodeOcean or GitHub repository (both have the same content).
@@ -118,13 +117,13 @@ $ git clone https://git.codeocean.com/capsule-3747729.git
118
  or
119
  ~~~bash
120
  # GitHub git repository
121
- $ git clone https://github.com/hkayabilisim/kate-cd.git
122
  ~~~
123
 
124
  The next step is to open VSCode, select *Open a Remote Window* and then *Open Folder in Container..." option. Select your cloned git folder and the VSCode should start building Docker container and open the content of the capsule.
125
 
126
  ### HuggingFace Access
127
- [HuggingFace](https://huggingface.co/datasets/cscsr/kate-cd) is used to host the database and provide a nice visual access to the developers. HuggingFace uses the Parquet format to host the database. HuggingFace also uses Large File Support (LFS) for the internal git repository. Therefore, we decided to isolate the git repository of HuggingFace from GitHub and CodeOcean. The git repository of HuggingFace host only the database (in Parquet format) and a README.
128
 
129
  The Parquet files in the HuggingFace repository are updated via:
130
 
@@ -149,3 +148,4 @@ If you visit [Open Science Library](https://codeocean.com/explore), you will see
149
 
150
 
151
 
 
 
30
  path: data/test-*
31
  ---
32
 
 
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
 
40
  The **KATE-CD Dataset** and the associated codes and supplementary information are published in three places i.e. CodeOcean, GitHub and HuggingFAce for providing redundancy and extended reach. All of the content uploaded to the three websites are the same except small differences because of platform requirements. The CodeOcean platform is mainly used for reproducibility, whereas GitHub is used to provide git access and hence easy collaboration between **KATE-CD Dataset** developers. Finally HuggingFace provides an easy access to the database where you can run existing models in HuggingFace on KATE-CD without too much effort.
41
 
 
98
  ### Differences between the platforms:
99
  * CodeOcean is the primary source of the dataset (*data* folder) and the codes (*code* folder).
100
  * GitHub does not contain *data* folder because GitHub is not designed to store and manage large files.
101
+ * [HuggingFace dataset](https://huggingface.co/datasets/cscrs/kate-cd) is hosted on an isolated repository with Large File Support (LFS). In this isolated repo, Parquet files of the original *data* folder are served. It also includes a README file with an auto-generated metadata for visual presentation on HuggingFace.
102
 
103
  ### GitHub Access
104
  If you would like to look at the capsule more closely, and build a working development environment then you can use [Development Containers](https://containers.dev/) functionality of VSCode. For this purpose, we created **.devcontainer/devcontainer.json** file under the root folder in the capsule. The purpose of this config file is to tell VSCode the location of the **Dockerfile**. Here, for design purposes, we used the same **Dockerfile** provided by CodeOcean. In this way, we do not interfere the building process in the CodeOcean.
105
 
106
  To open the GitHub repository in DevContainers, you can click the button below. It will open the VSCode in DevContainers mode and fetch the GitHub repository automatically.
107
 
108
+ [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/cscrs/kate-cd.git)
109
 
110
  ### CodeOcean Access
111
  To open the capsule in VSCode via [Development Containers](https://containers.dev/), you first need to download the capsule. There are two ways: either you can use the capsule export, or you can pull the capsule from git repository. We recommend using git. You can use either CodeOcean or GitHub repository (both have the same content).
 
117
  or
118
  ~~~bash
119
  # GitHub git repository
120
+ $ git clone https://github.com/cscrs/kate-cd.git
121
  ~~~
122
 
123
  The next step is to open VSCode, select *Open a Remote Window* and then *Open Folder in Container..." option. Select your cloned git folder and the VSCode should start building Docker container and open the content of the capsule.
124
 
125
  ### HuggingFace Access
126
+ [HuggingFace](https://huggingface.co/datasets/cscrs/kate-cd) is used to host the database and provide a nice visual access to the developers. HuggingFace uses the Parquet format to host the database. HuggingFace also uses Large File Support (LFS) for the internal git repository. Therefore, we decided to isolate the git repository of HuggingFace from GitHub and CodeOcean. The git repository of HuggingFace host only the database (in Parquet format) and a README.
127
 
128
  The Parquet files in the HuggingFace repository are updated via:
129
 
 
148
 
149
 
150
 
151
+