brunosan commited on
Commit
459726a
1 Parent(s): a87368d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -11
README.md CHANGED
@@ -6,6 +6,7 @@ license_link: https://raw.githubusercontent.com/Clay-foundation/model/main/LICEN
6
 
7
  # Clay documentation
8
 
 
9
 
10
  ## Overview
11
 
@@ -20,12 +21,12 @@ The Clay model primarily functions in two ways: first, by directly
20
  generating semantic embeddings for tasks like similarity searches, and
21
  second, through fine-tuning its outputs with additional data labels.
22
  This fine-tuning supports various tasks, including classification
23
- (e.g. flood detection and deforestation monitoring), regression
24
- (e.g. estimating carbon stock or crop yields), and generative tasks such
25
  as creating RGB imagery from SAR data. Moreover, users can further
26
  enhance model performance by incorporating higher-resolution data.
27
 
28
- This documentation uses [nbdev](#), which combines documentation, code
29
  samples and an SDK. This means that every page is also a python notebook
30
  anyone can use, with practical code examples for each functionality, and
31
  use case. Moreover, you can install `pip install clay` and use the same
@@ -39,7 +40,8 @@ Clay is open source, open data and open for business.
39
  - The Clay model **code** lives on
40
  [Github](https://github.com/Clay-foundation/model). License:
41
  [Apache](https://github.com/Clay-foundation/model/LICENSE).
42
- - The Clay model **weights** live on [Huggin Face](https://huggingface.co/made-with-clay/Clay/). License:
 
43
  [OpenRAIL-M](https://github.com/Clay-foundation/model/blob/main/LICENSE-MODEL.md).
44
  - The Clay **documentation** [lives on this
45
  site](https://clay-foundation.github.io/documentation/). License:
@@ -53,14 +55,14 @@ Clay is open source, open data and open for business.
53
 
54
  The model can be used in two main ways:
55
 
56
- 1. Directly, use it to make inference. See [Model](Model.html)
57
- 1. Check and run Benchmarks on the model. See
58
- [Benchmarks](Benchmarks.html)
59
  2. Generating semantic **embeddings**. E.g. for Similarity search. See
60
- [Embeddings](Embeddings.html).
61
  3. **Fine-tunning** the model for other tasks, or for other input data.
62
  E.g. flood detection, crop yields, … See
63
- [Fine-tunning](Fine-tunning.html).
 
 
64
 
65
  ## How to contribute
66
 
@@ -73,8 +75,7 @@ The Documentation, python package and notebooks are all the same
73
 
74
  > Note: If you want to contribute to the model code, please check the
75
  > [model repository](https://github.com/Clay-foundation/model).
76
-
77
-
78
 
79
 
80
  Clay is a fiscally sponsored project of [Radiant Earth](), a USA
 
6
 
7
  # Clay documentation
8
 
9
+ <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
10
 
11
  ## Overview
12
 
 
21
  generating semantic embeddings for tasks like similarity searches, and
22
  second, through fine-tuning its outputs with additional data labels.
23
  This fine-tuning supports various tasks, including classification
24
+ (e.g. flood detection and deforestation monitoring), regression
25
+ (e.g. estimating carbon stock or crop yields), and generative tasks such
26
  as creating RGB imagery from SAR data. Moreover, users can further
27
  enhance model performance by incorporating higher-resolution data.
28
 
29
+ This documentation uses `nbdev`, which combines documentation, code
30
  samples and an SDK. This means that every page is also a python notebook
31
  anyone can use, with practical code examples for each functionality, and
32
  use case. Moreover, you can install `pip install clay` and use the same
 
40
  - The Clay model **code** lives on
41
  [Github](https://github.com/Clay-foundation/model). License:
42
  [Apache](https://github.com/Clay-foundation/model/LICENSE).
43
+ - The Clay model **weights** live on [Huggin
44
+ Face](https://huggingface.co/made-with-clay/Clay/). License:
45
  [OpenRAIL-M](https://github.com/Clay-foundation/model/blob/main/LICENSE-MODEL.md).
46
  - The Clay **documentation** [lives on this
47
  site](https://clay-foundation.github.io/documentation/). License:
 
55
 
56
  The model can be used in two main ways:
57
 
58
+ 1. Directly, use it to make inference. See [Model](https://clay-foundation.github.io/documentation/model.html)
 
 
59
  2. Generating semantic **embeddings**. E.g. for Similarity search. See
60
+ [Embeddings](https://clay-foundation.github.io/documentation/embeddings.html).
61
  3. **Fine-tunning** the model for other tasks, or for other input data.
62
  E.g. flood detection, crop yields, … See
63
+ [Fine-tunning](https://clay-foundation.github.io/documentation/finetunning.html).
64
+
65
+ See Model v0 [Release notes](https://clay-foundation.github.io/documentation/Clay%20Model%20releases/clay%20v0%20release.html)
66
 
67
  ## How to contribute
68
 
 
75
 
76
  > Note: If you want to contribute to the model code, please check the
77
  > [model repository](https://github.com/Clay-foundation/model).
78
+ >
 
79
 
80
 
81
  Clay is a fiscally sponsored project of [Radiant Earth](), a USA