Add Get Started code and Paper citation

#4
Files changed (1) hide show
  1. README.md +45 -3
README.md CHANGED
@@ -2,10 +2,52 @@
2
  license: mit
3
  language:
4
  - en
5
- tags:
6
- - deepforest
7
  ---
8
 
 
9
  ## Tree Crown Detection in RGB Airborne Imagery
10
 
11
- The model was initially described in [Remote Sensing](https://www.mdpi.com/2072-4292/11/11/1309) on a single site. The prebuilt model uses a semi-supervised approach in which millions of moderate quality annotations are generated using a LiDAR unsupervised tree detection algorithm, followed by hand-annotations of RGB imagery from select sites. Comparisons among geographic sites were added to [Ecological Informatics](https://www.sciencedirect.com/science/article/pii/S157495412030011X). The model was further improved, and the Python package was released in [Methods in Ecology and Evolution](https://besjournals.onlinelibrary.wiley.com/doi/full/10.1111/2041-210X.13472).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  license: mit
3
  language:
4
  - en
 
 
5
  ---
6
 
7
+
8
  ## Tree Crown Detection in RGB Airborne Imagery
9
 
10
+ The model was initially described in [Remote Sensing](https://www.mdpi.com/2072-4292/11/11/1309) on a single site. The prebuilt model uses a semi-supervised approach in which millions of moderate quality annotations are generated using a LiDAR unsupervised tree detection algorithm, followed by hand-annotations of RGB imagery from select sites. Comparisons among geographic sites were added to [Ecological Informatics](https://www.sciencedirect.com/science/article/pii/S157495412030011X). The model was further improved, and the Python package was released in [Methods in Ecology and Evolution](https://besjournals.onlinelibrary.wiley.com/doi/full/10.1111/2041-210X.13472).
11
+
12
+ - **Repository:** https://github.com/weecology/DeepForest
13
+ - **Paper :** https://www.sciencedirect.com/science/article/pii/S157495412030011X
14
+ - **Demo :** https://huggingface.co/spaces/weecology/deepforest-demo
15
+
16
+
17
+ ## How to Get Started with the Model
18
+
19
+ Use the code below to get started with the model.
20
+
21
+ ```
22
+ from deepforest import main
23
+ from deepforest import get_data
24
+ from deepforest.visualize import plot_results
25
+ # Initialize the model class
26
+ model = main.deepforest()
27
+
28
+ # Load a pretrained tree detection model from Hugging Face
29
+ model.load_model(model_name="weecology/deepforest-tree", revision="main")
30
+
31
+ sample_image_path = get_data("OSBS_029.png")
32
+ img = model.predict_image(path=sample_image_path)
33
+ plot_results(img)
34
+ ```
35
+
36
+
37
+ ## Citation
38
+ ```
39
+ @article{WEINSTEIN2020101061,
40
+ title = {Cross-site learning in deep learning RGB tree crown detection},
41
+ journal = {Ecological Informatics},
42
+ volume = {56},
43
+ pages = {101061},
44
+ year = {2020},
45
+ issn = {1574-9541},
46
+ doi = {https://doi.org/10.1016/j.ecoinf.2020.101061},
47
+ url = {https://www.sciencedirect.com/science/article/pii/S157495412030011X},
48
+ author = {Ben G. Weinstein and Sergio Marconi and Stephanie A. Bohlman and Alina Zare and Ethan P. White},
49
+ ```
50
+
51
+ ## Model Card Authors
52
+
53
+ Ben G. Weinstein, Sergio Marconi, Stephanie A. Bohlman, Alina Zare and Ethan P. White