Update README.md
Browse files
README.md
CHANGED
@@ -4,79 +4,26 @@ license_name: open-rail-m
|
|
4 |
license_link: https://raw.githubusercontent.com/Clay-foundation/model/main/LICENSE-MODEL.md
|
5 |
---
|
6 |
|
7 |
-
# Clay
|
8 |
|
9 |
-
|
10 |
|
11 |
-
|
12 |
|
13 |
-
Clay
|
14 |
-
|
15 |
-
|
16 |
-
|
17 |
-
fundational task is a [Masked Autoencoder
|
18 |
-
(MAE)](https://arxiv.org/abs/2111.06377) approach for training.
|
19 |
|
20 |
-
The Clay model primarily functions in two ways: first, by directly
|
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
|
33 |
-
functions.
|
34 |
-
|
35 |
-
Clay is open source, open data and open for business.
|
36 |
|
37 |
## Where is what
|
38 |
|
39 |
- Our **website** is [madewithclay.org](https://madewithclay.org).
|
40 |
-
- The Clay model **code** lives on
|
41 |
-
[
|
42 |
-
|
43 |
-
-
|
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:
|
48 |
-
[CC-BY](#).
|
49 |
-
- The Clay **SDK** lives on
|
50 |
-
[PyPi](https://pypi.org/project/madewithclay/). License: [Apache](#).
|
51 |
-
- We maintain a set of **embeddings** on [Source Cooperative](#).
|
52 |
-
License: [ODC-BY](#).
|
53 |
-
|
54 |
-
## How to use Clay
|
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 |
-
|
69 |
-
Clay is an open source project, and we welcome contributions of all
|
70 |
-
kinds.
|
71 |
|
72 |
-
|
73 |
-
[NBdev](https://nbdev.fast.ai/) project, located
|
74 |
-
[here](https://github.com/Clay-foundation/documentation).
|
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
|
82 |
-
registered 501(c)3 non-profit.
|
|
|
4 |
license_link: https://raw.githubusercontent.com/Clay-foundation/model/main/LICENSE-MODEL.md
|
5 |
---
|
6 |
|
7 |
+
# Clay Foundation Model
|
8 |
|
9 |
+
## An open source AI model for Earth
|
10 |
|
11 |
+
Clay is a foundational model of Earth. It uses an expanded visual transformer upgraded to understand geospatial and temporal relations on Earth data. The model is trained as a self-supervised Masked Autoencoder (MAE).
|
12 |
|
13 |
+
The Clay model can be used in three main ways:
|
14 |
+
- Generate semantic embeddings for any location and time.
|
15 |
+
- Fine-tune the model for downstream tasks such as classification, regression, and generative tasks.
|
16 |
+
- Use the model as a backbone for other models.
|
|
|
|
|
17 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
18 |
|
19 |
## Where is what
|
20 |
|
21 |
- Our **website** is [madewithclay.org](https://madewithclay.org).
|
22 |
+
- The Clay model **code** lives on [Github](https://github.com/Clay-foundation/model). License: [Apache](https://github.com/Clay-foundation/model/LICENSE). The latest release is [v0.0.1](https://github.com/Clay-foundation/model/releases/tag/v0.0.1)
|
23 |
+
- The Clay model **weights** on [Hugging Face](https://huggingface.co/made-with-clay/Clay/). License: [OpenRAIL-M](https://github.com/Clay-foundation/model/blob/main/LICENSE-MODEL.md).
|
24 |
+
- The Clay **documentation** [lives on this site](https://clay-foundation.github.io/model/intro.html). License: [CC-BY](http://creativecommons.org/licenses/by/4.0/).
|
25 |
+
- *Coming Soon* > We maintain a set of **embeddings** on [Source Cooperative](https://beta.source.coop/clay/). License: [ODC-BY](https://opendatacommons.org/licenses/by/).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
26 |
|
27 |
+
CLAY is a fiscal sponsored project of the 501c3 non-profit [Radiant Earth Foundation](https://www.radiant.earth/).
|
|
|
|
|
28 |
|
|
|
|
|
|
|
|
|
29 |
|
|
|
|