Add missing Explorer docs reference pages (#7455)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: ayush chaurasia <ayush.chaurarsia@gmail.com>
pull/7460/head
Glenn Jocher 1 year ago committed by GitHub
parent b99113f83a
commit 06b26105aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 21
      docs/en/reference/data/explorer/explorer.md
  2. 58
      docs/en/reference/data/explorer/gui/dash.md
  3. 33
      docs/en/reference/data/explorer/utils.md

@ -0,0 +1,21 @@
---
comments: true
description: Comprehensive reference for the Explorer API. Get a brief description of all the main classes utilised for creating and handling the data in the Ultralytics data explorer project.
keywords: Ultralytics, explorer.py, data explorer, Semantic search, vector similarity search, class reference, documentation, ExplorerDataset, Explorer, data handling
---
# Reference for `ultralytics/data/explorer/explorer.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/explorer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/explorer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/explorer.py) 🛠. Thank you 🙏!
<br><br>
## ::: ultralytics.data.explorer.explorer.ExplorerDataset
<br><br>
## ::: ultralytics.data.explorer.explorer.Explorer
<br><br>

@ -0,0 +1,58 @@
---
comments: true
description: Detailed reference for the Explorer GUI. Includes brief descriptions for all the major functions used in the dashboard demo of Explorer API.
keywords: Ultralytics, data explorer, gui, function reference, documentation, AI queries, image similarity, SQL queries, streamlit, semantic search
---
# Reference for `ultralytics/data/explorer/gui/dash.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/gui/dash.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/gui/dash.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/gui/dash.py) 🛠. Thank you 🙏!
<br><br>
## ::: ultralytics.data.explorer.gui.dash._get_explorer
<br><br>
## ::: ultralytics.data.explorer.gui.dash.init_explorer_form
<br><br>
## ::: ultralytics.data.explorer.gui.dash.query_form
<br><br>
## ::: ultralytics.data.explorer.gui.dash.ai_query_form
<br><br>
## ::: ultralytics.data.explorer.gui.dash.find_similar_imgs
<br><br>
## ::: ultralytics.data.explorer.gui.dash.similarity_form
<br><br>
## ::: ultralytics.data.explorer.gui.dash.run_sql_query
<br><br>
## ::: ultralytics.data.explorer.gui.dash.run_ai_query
<br><br>
## ::: ultralytics.data.explorer.gui.dash.reset_explorer
<br><br>
## ::: ultralytics.data.explorer.gui.dash.utralytics_explorer_docs_callback
<br><br>
## ::: ultralytics.data.explorer.gui.dash.layout
<br><br>

@ -0,0 +1,33 @@
---
comments: true
description: Detailed reference for the Explorer utils. Provides descriptions and details on important utility functions for managing and interacting with data in the Ultralytics explorer project.
keywords: Ultralytics, data explorer, function reference, documentation, get table schema, get sim index schema, sanitize batch, plot query result, prompt SQL query
---
# Reference for `ultralytics/data/explorer/utils.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/utils.py) 🛠. Thank you 🙏!
<br><br>
## ::: ultralytics.data.explorer.utils.get_table_schema
<br><br>
## ::: ultralytics.data.explorer.utils.get_sim_index_schema
<br><br>
## ::: ultralytics.data.explorer.utils.sanitize_batch
<br><br>
## ::: ultralytics.data.explorer.utils.plot_query_result
<br><br>
## ::: ultralytics.data.explorer.utils.prompt_sql_query
<br><br>
Loading…
Cancel
Save