Skip to content

Commit 7c1824b

Browse files
authored
Merge pull request #1976 from kili-technology/feature/lab-3920-adjust-sdk-documentation-replace-geosatgeospatial-geospatial
docs(LAB-3920): convert `geosat` -> `geospatial` in all docs
2 parents e6b6bfb + 5567c39 commit 7c1824b

File tree

5 files changed

+31
-31
lines changed

5 files changed

+31
-31
lines changed

docs/sdk/tutorials/importing_multilayer_geosat_assets.md renamed to docs/sdk/tutorials/importing_multilayer_geospatial_assets.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!-- FILE AUTO GENERATED BY docs/utils.py DO NOT EDIT DIRECTLY -->
2-
<a href="https://colab.research.google.com/github/kili-technology/kili-python-sdk/blob/main/recipes/importing_multilayer_geosat_assets.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
2+
<a href="https://colab.research.google.com/github/kili-technology/kili-python-sdk/blob/main/recipes/importing_multilayer_geospatial_assets.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
33

4-
# How to import multi-layer geosat assets to a Kili project
4+
# Importing Multi-Layer Geospatial Images into a Kili Project
55

6-
In this tutorial, we will learn how to import multi-layer geosat assets to your project.
6+
In this tutorial, we will learn how to import multi-layer geospatial assets to your project.
77

88
Here are the steps that we will follow:
99

@@ -75,7 +75,7 @@ interface = {
7575
}
7676

7777
project = kili.create_project(
78-
title="[Kili SDK Notebook]: Importing multi-layer Geosatellite asset",
78+
title="[Kili SDK Notebook]: Importing multi-layer Geospatial asset",
7979
description="Project Description",
8080
input_type="IMAGE",
8181
json_interface=interface,
@@ -86,22 +86,22 @@ project = kili.create_project(
8686

8787
### Download geotiff file examples
8888

89-
Before adding assets you need to download our geotiff examples and add them in a geosat folder, created in the same folder as where you run your python script. It is mandatory to use local files and not urls for geosatellite files.
89+
Before adding assets you need to download our geotiff examples and add them in a geospatial folder, created in the same folder as where you run your python script. It is mandatory to use local files and not urls for geospatial files.
9090

9191

9292
```python
9393
import os
9494
import urllib.request
9595

96-
if not os.path.exists("geosat"):
97-
os.makedirs("geosat")
96+
if not os.path.exists("geospatial"):
97+
os.makedirs("geospatial")
9898
urllib.request.urlretrieve(
99-
"https://storage.googleapis.com/label-public-staging/asset-test-sample/geosat/a.tiff",
100-
"geosat/a.tiff",
99+
"https://storage.googleapis.com/label-public-staging/asset-test-sample/geospatial/a.tiff",
100+
"geospatial/a.tiff",
101101
)
102102
urllib.request.urlretrieve(
103-
"https://storage.googleapis.com/label-public-staging/asset-test-sample/geosat/b.tiff",
104-
"geosat/b.tiff",
103+
"https://storage.googleapis.com/label-public-staging/asset-test-sample/geospatial/b.tiff",
104+
"geospatial/b.tiff",
105105
)
106106
```
107107

@@ -116,12 +116,12 @@ json_metadata_array = [{"processingParameters": {"epsg": 3857}}]
116116
multi_layer_content_array = [
117117
[
118118
{
119-
"path": "geosat/a.tiff",
119+
"path": "geospatial/a.tiff",
120120
"name": "Layer 1",
121121
"isBaseLayer": False,
122122
},
123123
{
124-
"path": "geosat/b.tiff",
124+
"path": "geospatial/b.tiff",
125125
"name": "Layer 2",
126126
"isBaseLayer": False,
127127
},
@@ -156,7 +156,7 @@ kili.append_many_to_dataset(
156156
In this example 4 arguments are used for the `append_many_to_dataset` function :
157157

158158
1. `project_id`: the id of the project to which you want to add the asset
159-
1. `multi_layer_content_array`: it is a list of dictionnaries representing the layers created from geosatellite files like GEOTIFFS. For each GEOTIFF you have to set the `path` to the GEOTIFF, the `name` that will be used in kili for the layer and the boolean `isBaseLayer` to define if it's a base layer (only one visible at a time) or an overlay layer (a layer that will be displayed on top of the base layer). This last one is optional and by default if no parameter is set, we consider it is a base layer.
159+
1. `multi_layer_content_array`: it is a list of dictionnaries representing the layers created from geospatial files like GEOTIFFS. For each GEOTIFF you have to set the `path` to the GEOTIFF, the `name` that will be used in kili for the layer and the boolean `isBaseLayer` to define if it's a base layer (only one visible at a time) or an overlay layer (a layer that will be displayed on top of the base layer). This last one is optional and by default if no parameter is set, we consider it is a base layer.
160160
1. `json_metadata_array`: This one contains the processing parameters that will be used when processing the files. 3 parameters can be set there :
161161
1. `epsg`: This one defines the projection (<https://en.wikipedia.org/wiki/EPSG_Geodetic_Parameter_Dataset>) to which we will reproject the dataset. Our frontend supports only two projections : `EPSG:4326` and `EPSG:3857`. If this parameter is not set we will keep the projection of the initial file if it is one of these two, else we will reproject it by default to `EPSG:3857`. By default, we advise to not set this parameter but if you need to use your GEOTIFFS with some tile server (as with openstreetmap here) you will need to reproject it to the same EPSG as the one used by the tile server as our application supports only one EPSG for the whole asset. For your information most of the well known tile server (openstreetmap, googlemaps, etc) are using `EPSG:3857`.
162162
1. `maxZoom` and `minZoom`: these defines limits of zoom for your GEOTIFF files. This is especially useful for files that will be tiled by our server (file size > 30MB). By default we generate all the zooms until the one of the original file but if you want to limit to specific zoom levels you can constrain them with these parameters.

docs/tutorials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Because videos and Rich Text assets may be more complex to import, we’ve creat
1919
- For video assets, refer to [this tutorial](https://python-sdk-docs.kili-technology.com/latest/sdk/tutorials/importing_video_assets/).
2020
- For rich text assets, see [here](https://python-sdk-docs.kili-technology.com/latest/sdk/tutorials/import_text_assets).
2121
- For PDF assets, see [here](https://python-sdk-docs.kili-technology.com/latest/sdk/tutorials/importing_pdf_assets).
22-
- For Geosat multi-layer assets, see [here](https://python-sdk-docs.kili-technology.com/latest/sdk/tutorials/importing_multilayer_geosat_assets).
22+
- For Geospatial multi-layer assets, see [here](https://python-sdk-docs.kili-technology.com/latest/sdk/tutorials/importing_multilayer_geospatial_assets).
2323
- For LLM Static, see [here](https://python-sdk-docs.kili-technology.com/latest/sdk/tutorials/llm_static/).
2424

2525
## Importing labels

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ nav:
4242
- Video Assets: sdk/tutorials/importing_video_assets.md
4343
- PDF Assets: sdk/tutorials/importing_pdf_assets.md
4444
- Rich Text Assets: sdk/tutorials/import_text_assets.md
45-
- Multi-Layer Geosatellite Assets: sdk/tutorials/importing_multilayer_geosat_assets.md
45+
- Multi-Layer Geospatial Assets: sdk/tutorials/importing_multilayer_geospatial_assets.md
4646
- LLM Static Assets : sdk/tutorials/llm_static.md
4747
- Importing Labels:
4848
- Importing Labels: sdk/tutorials/importing_labels.md

recipes/importing_multilayer_geosat_assets.ipynb renamed to recipes/importing_multilayer_geospatial_assets.ipynb

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"<a href=\"https://colab.research.google.com/github/kili-technology/kili-python-sdk/blob/main/recipes/importing_multilayer_geosat_assets.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
7+
"<a href=\"https://colab.research.google.com/github/kili-technology/kili-python-sdk/blob/main/recipes/importing_multilayer_geospatial_assets.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
88
]
99
},
1010
{
1111
"cell_type": "markdown",
1212
"metadata": {},
1313
"source": [
14-
"# How to import multi-layer geosat assets to a Kili project\n",
14+
"# Importing Multi-Layer Geospatial Images into a Kili Project\n",
1515
"\n",
16-
"In this tutorial, we will learn how to import multi-layer geosat assets to your project.\n",
16+
"In this tutorial, we will learn how to import multi-layer geospatial assets to your project.\n",
1717
"\n",
1818
"Here are the steps that we will follow:\n",
1919
"\n",
@@ -112,7 +112,7 @@
112112
"}\n",
113113
"\n",
114114
"project = kili.create_project(\n",
115-
" title=\"[Kili SDK Notebook]: Importing multi-layer Geosatellite asset\",\n",
115+
" title=\"[Kili SDK Notebook]: Importing multi-layer Geospatial asset\",\n",
116116
" description=\"Project Description\",\n",
117117
" input_type=\"IMAGE\",\n",
118118
" json_interface=interface,\n",
@@ -127,7 +127,7 @@
127127
"\n",
128128
"### Download geotiff file examples\n",
129129
"\n",
130-
"Before adding assets you need to download our geotiff examples and add them in a geosat folder, created in the same folder as where you run your python script. It is mandatory to use local files and not urls for geosatellite files."
130+
"Before adding assets you need to download our geotiff examples and add them in a geospatial folder, created in the same folder as where you run your python script. It is mandatory to use local files and not urls for geospatial files."
131131
]
132132
},
133133
{
@@ -139,15 +139,15 @@
139139
"import os\n",
140140
"import urllib.request\n",
141141
"\n",
142-
"if not os.path.exists(\"geosat\"):\n",
143-
" os.makedirs(\"geosat\")\n",
142+
"if not os.path.exists(\"geospatial\"):\n",
143+
" os.makedirs(\"geospatial\")\n",
144144
"urllib.request.urlretrieve(\n",
145-
" \"https://storage.googleapis.com/label-public-staging/asset-test-sample/geosat/a.tiff\",\n",
146-
" \"geosat/a.tiff\",\n",
145+
" \"https://storage.googleapis.com/label-public-staging/asset-test-sample/geospatial/a.tiff\",\n",
146+
" \"geospatial/a.tiff\",\n",
147147
")\n",
148148
"urllib.request.urlretrieve(\n",
149-
" \"https://storage.googleapis.com/label-public-staging/asset-test-sample/geosat/b.tiff\",\n",
150-
" \"geosat/b.tiff\",\n",
149+
" \"https://storage.googleapis.com/label-public-staging/asset-test-sample/geospatial/b.tiff\",\n",
150+
" \"geospatial/b.tiff\",\n",
151151
")"
152152
]
153153
},
@@ -171,12 +171,12 @@
171171
"multi_layer_content_array = [\n",
172172
" [\n",
173173
" {\n",
174-
" \"path\": \"geosat/a.tiff\",\n",
174+
" \"path\": \"geospatial/a.tiff\",\n",
175175
" \"name\": \"Layer 1\",\n",
176176
" \"isBaseLayer\": False,\n",
177177
" },\n",
178178
" {\n",
179-
" \"path\": \"geosat/b.tiff\",\n",
179+
" \"path\": \"geospatial/b.tiff\",\n",
180180
" \"name\": \"Layer 2\",\n",
181181
" \"isBaseLayer\": False,\n",
182182
" },\n",
@@ -215,7 +215,7 @@
215215
"In this example 4 arguments are used for the `append_many_to_dataset` function :\n",
216216
"\n",
217217
"1. `project_id`: the id of the project to which you want to add the asset\n",
218-
"1. `multi_layer_content_array`: it is a list of dictionnaries representing the layers created from geosatellite files like GEOTIFFS. For each GEOTIFF you have to set the `path` to the GEOTIFF, the `name` that will be used in kili for the layer and the boolean `isBaseLayer` to define if it's a base layer (only one visible at a time) or an overlay layer (a layer that will be displayed on top of the base layer). This last one is optional and by default if no parameter is set, we consider it is a base layer.\n",
218+
"1. `multi_layer_content_array`: it is a list of dictionnaries representing the layers created from geospatial files like GEOTIFFS. For each GEOTIFF you have to set the `path` to the GEOTIFF, the `name` that will be used in kili for the layer and the boolean `isBaseLayer` to define if it's a base layer (only one visible at a time) or an overlay layer (a layer that will be displayed on top of the base layer). This last one is optional and by default if no parameter is set, we consider it is a base layer.\n",
219219
"1. `json_metadata_array`: This one contains the processing parameters that will be used when processing the files. 3 parameters can be set there :\n",
220220
" 1. `epsg`: This one defines the projection (<https://en.wikipedia.org/wiki/EPSG_Geodetic_Parameter_Dataset>) to which we will reproject the dataset. Our frontend supports only two projections : `EPSG:4326` and `EPSG:3857`. If this parameter is not set we will keep the projection of the initial file if it is one of these two, else we will reproject it by default to `EPSG:3857`. By default, we advise to not set this parameter but if you need to use your GEOTIFFS with some tile server (as with openstreetmap here) you will need to reproject it to the same EPSG as the one used by the tile server as our application supports only one EPSG for the whole asset. For your information most of the well known tile server (openstreetmap, googlemaps, etc) are using `EPSG:3857`.\n",
221221
" 1. `maxZoom` and `minZoom`: these defines limits of zoom for your GEOTIFF files. This is especially useful for files that will be tiled by our server (file size > 30MB). By default we generate all the zooms until the one of the original file but if you want to limit to specific zoom levels you can constrain them with these parameters.\n",

src/kili/entrypoints/mutations/asset/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def append_many_to_dataset(
7171
- For an `LLM_RLHF` project, the content can be dicts with the keys `prompt` and `completions`,
7272
paths to local json files or URLs to json files.
7373
multi_layer_content_array: List containing multiple lists of paths.
74-
Each path correspond to a layer of a geosat asset. Should be used only for `IMAGE` projects.
74+
Each path correspond to a layer of a geospatial asset. Should be used only for `IMAGE` and `GEOSPATIAL` projects.
7575
external_id_array: List of external ids given to identify the assets.
7676
If None, random identifiers are created.
7777
id_array: Disabled parameter. Do not use.

0 commit comments

Comments
 (0)