vancauwe commited on
Commit
7af40e7
Β·
1 Parent(s): aba41f2

chore: fix page documentation

Browse files
docs/dataset_download.md CHANGED
@@ -1,3 +1,3 @@
1
  This module provides a download function for accessing the hugging face Dataset.
2
 
3
- ::: src.data.download
 
1
  This module provides a download function for accessing the hugging face Dataset.
2
 
3
+ ::: src.dataset.download
docs/home.md CHANGED
@@ -7,4 +7,4 @@ The session state is used to retain values from one interaction to the next, sin
7
  See streamlit [docs](https://docs.streamlit.io/develop/api-reference/caching-and-state/st.session_state).
8
 
9
 
10
- ::: src.main
 
7
  See streamlit [docs](https://docs.streamlit.io/develop/api-reference/caching-and-state/st.session_state).
8
 
9
 
10
+ ::: src.home
docs/pages.md CHANGED
@@ -1 +1,12 @@
1
- The pages documented are the pages with functional code. Some pages such as about, benchmarking, challenges are currently only writing, markdown and images and do not require further documentation.
 
 
 
 
 
 
 
 
 
 
 
 
1
+ The UI is organized into a multipage streamlit app.
2
+
3
+ The pages cover the main functionalities of the code.
4
+
5
+ Some pages do not yet have code implemented for them: they represent a concept more than a functionality. Such pages are `About`, `Benchmarking`, `Challenges` which are currently only writing, markdown and images and do not require further documentation.
6
+
7
+ Pages that have fully implemented code and functionality are the following:
8
+
9
+ - Maps
10
+ - Classifiers
11
+ - Gallery
12
+ - Logs
docs/pages_classifiers.md DELETED
@@ -1,3 +0,0 @@
1
- This page displays the input mechanism for your images as well as all the classifiers which can do inference on your image.
2
-
3
- ::: src.pages.4_πŸ”₯_classifiers
 
 
 
 
docs/pages_gallery.md DELETED
@@ -1,3 +0,0 @@
1
- This page displays all the cetacean species that can be identified by classifiers.
2
-
3
- ::: src.pages.7_🌊_gallery
 
 
 
 
docs/pages_logs.md DELETED
@@ -1,3 +0,0 @@
1
- This page displays all the logs coming from user interactions with the platform and from back-end queries to the hugging face server.
2
-
3
- ::: src.pages.πŸ“Š_logs
 
 
 
 
docs/pages_map.md DELETED
@@ -1,3 +0,0 @@
1
- This page displays the recorded observations of the dataset on a map.
2
-
3
- ::: src.pages.2_🌍_map
 
 
 
 
docs/pages_requests.md DELETED
@@ -1,3 +0,0 @@
1
- This page displays the data that can be requested. The default view is over all the data in the dataset. The filters on the side bar allow to narrow down on different geographical zones as well as on different time frames.
2
-
3
- ::: src.pages.3_🀝_data requests
 
 
 
 
mkdocs.yaml CHANGED
@@ -27,13 +27,7 @@ nav:
27
  - Dev Notes: dev_notes.md
28
  - App:
29
  - Main App & Home Page: home.md
30
- - Pages:
31
- - Overall Notes: pages.md
32
- - Map Page: pages_map.md
33
- - Requests Page: pages_requests.md
34
- - Classifiers Page: pages_classifiers.md
35
- - Gallery Page: pages_gallery.md
36
- - Logs: pages_logs.md
37
  - Modules:
38
  - Data Entry Handling:
39
  - Data Input: input_handling.md
 
27
  - Dev Notes: dev_notes.md
28
  - App:
29
  - Main App & Home Page: home.md
30
+ - Multipages Notes: pages.md
 
 
 
 
 
 
31
  - Modules:
32
  - Data Entry Handling:
33
  - Data Input: input_handling.md
docs/index.md β†’ src/dataset/__init__.py RENAMED
File without changes