Update README to include bibtex.

#4
by xhagrg - opened
Files changed (1) hide show
  1. README.md +21 -9
README.md CHANGED
@@ -18,7 +18,7 @@ metrics:
18
  ---
19
 
20
  ### Model and Inputs
21
- The pretrained [Prithvi-100m](https://huggingface.co/ibm-nasa-geospatial/Prithvi-100M/blob/main/README.md) parameter model is finetuned to detect Burn Scars on HLS data from the [HLS Burn Scar Scenes dataset](https://huggingface.co/datasets/ibm-nasa-geospatial/hls_burn_scars). This dataset includes input tiles of 512x512x6, where 512 is the height and width and 6 is the number of bands. The bands are:
22
 
23
  1. Blue
24
  2. Green
@@ -27,19 +27,31 @@ The pretrained [Prithvi-100m](https://huggingface.co/ibm-nasa-geospatial/Prithvi
27
  5. SWIR 1
28
  6. SWIR 2
29
  ![](burn_scar.png)
30
- It is important to point out that the HLS Burn Scar Scenes dataset includes a single timestep, while the Prithvi-100m was pretrained with 3 timesteps. This highlights the flexibility of this model to adapt to different downstream tasks and requirements.
31
 
32
  ### Code
33
- Code for Finetuning is available through [github](https://github.com/NASA-IMPACT/hls-foundation-os/tree/main/fine-tuning-examples)
34
 
35
- Configuration used for finetuning is available through [config](https://github.com/NASA-IMPACT/hls-foundation-os/blob/main/fine-tuning-examples/configs/firescars_config.py
36
  ).
37
 
38
  ### Results
39
- The experiment by running the mmseg stack for 50 epochs using the above config led to an IoU of **0.72** on the burn scar class and **0.96** overall accuracy. It is noteworthy that this leads to a resonably good model, but further developement will most likely improve performance.
40
 
41
  ### Inference and demo
42
- The github repo includes an inference script that allows to run the burn scar model for inference on HLS images. These input have to be geotiff format, including the channels described above (Blue, Green, Red, Narrow NIR, SWIR, SWIR 2) in reflectance units [0-1]. There is also a **demo** that leverages the same code **[here](https://huggingface.co/spaces/ibm-nasa-geospatial/Prithvi-100M-Burn-scars-demo)**.
43
-
44
-
45
-
 
 
 
 
 
 
 
 
 
 
 
 
 
18
  ---
19
 
20
  ### Model and Inputs
21
+ The pre-trained [Prithvi-100m](https://huggingface.co/ibm-nasa-geospatial/Prithvi-100M/blob/main/README.md) parameter model is fine-tuned to detect burn scars on HLS data from the [HLS burn scar scenes dataset](https://huggingface.co/datasets/ibm-nasa-geospatial/hls_burn_scars). This dataset includes input tiles of 512x512x6, where 512 is the height and width and 6 is the number of bands. The bands are:
22
 
23
  1. Blue
24
  2. Green
 
27
  5. SWIR 1
28
  6. SWIR 2
29
  ![](burn_scar.png)
30
+ It is important to point out that the HLS burn scar scenes dataset includes a single timestep, while the Prithvi-100m was pretrained with three timesteps. The difference highlights the flexibility of this model to adapt to different downstream tasks and requirements.
31
 
32
  ### Code
33
+ Code for fine-tuning is available through [Github](https://github.com/NASA-IMPACT/hls-foundation-os/tree/main/fine-tuning-examples)
34
 
35
+ Configuration used for fine-tuning is available through [config](https://github.com/NASA-IMPACT/hls-foundation-os/blob/main/fine-tuning-examples/configs/firescars_config.py
36
  ).
37
 
38
  ### Results
39
+ The experiment conducted by running the mmseg stack for 50 epochs using the above config led to an IoU of **0.72** on the burn scar class and **0.96** overall accuracy. It is noteworthy that this leads to a reasonably good model, but further developement will most likely improve performance.
40
 
41
  ### Inference and demo
42
+ The github repo includes an inference script that allows to run the burn scar model for inference on HLS images. These inputs have to be in geotiff format, including the channels described above (Blue, Green, Red, Narrow NIR, SWIR, SWIR 2) in reflectance units [0-1]. A **demo** that leverages the same code can be found **[here](https://huggingface.co/spaces/ibm-nasa-geospatial/Prithvi-100M-Burn-scars-demo)**.
43
+
44
+ ### Citation
45
+
46
+ If this model helped your research, please cite `Prithvi-100M-burn-scar` in your publications. Here is an example BibTeX entry:
47
+
48
+ ```
49
+ @misc{Prithvi-100M-burn-scar,
50
+ author = {Roy, Sujit and Phillips, Christopher and Jakubik, Johannes and Fraccaro, Paolo and Ankur, Kumar and Avery, Ryan and Ji, Wei and Zadrozny, Bianca and Ramachandran, Rahul},
51
+ doi = {https://huggingface.co/ibm-nasa-geospatial/Prithvi-100M-burn-scar},
52
+ month = aug,
53
+ title = {{Prithvi 100M burn scar}},
54
+ url = {https://huggingface.co/ibm-nasa-geospatial/Prithvi-100M-burn-scar},
55
+ year = {2023}
56
+ }
57
+ ```