diff --git a/docs/en/reference/data/explorer/explorer.md b/docs/en/reference/data/explorer/explorer.md new file mode 100644 index 00000000..d8608635 --- /dev/null +++ b/docs/en/reference/data/explorer/explorer.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 🙏! + +

+ +## ::: ultralytics.data.explorer.explorer.ExplorerDataset + +

+ +## ::: ultralytics.data.explorer.explorer.Explorer + +

diff --git a/docs/en/reference/data/explorer/gui/dash.md b/docs/en/reference/data/explorer/gui/dash.md new file mode 100644 index 00000000..4b69ac52 --- /dev/null +++ b/docs/en/reference/data/explorer/gui/dash.md @@ -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 🙏! + +

+ +## ::: ultralytics.data.explorer.gui.dash._get_explorer + +

+ +## ::: ultralytics.data.explorer.gui.dash.init_explorer_form + +

+ +## ::: ultralytics.data.explorer.gui.dash.query_form + +

+ +## ::: ultralytics.data.explorer.gui.dash.ai_query_form + +

+ +## ::: ultralytics.data.explorer.gui.dash.find_similar_imgs + +

+ +## ::: ultralytics.data.explorer.gui.dash.similarity_form + +

+ +## ::: ultralytics.data.explorer.gui.dash.run_sql_query + +

+ +## ::: ultralytics.data.explorer.gui.dash.run_ai_query + +

+ +## ::: ultralytics.data.explorer.gui.dash.reset_explorer + +

+ +## ::: ultralytics.data.explorer.gui.dash.utralytics_explorer_docs_callback + +

+ +## ::: ultralytics.data.explorer.gui.dash.layout + +

diff --git a/docs/en/reference/data/explorer/utils.md b/docs/en/reference/data/explorer/utils.md new file mode 100644 index 00000000..d1769c5e --- /dev/null +++ b/docs/en/reference/data/explorer/utils.md @@ -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 🙏! + +

+ +## ::: ultralytics.data.explorer.utils.get_table_schema + +

+ +## ::: ultralytics.data.explorer.utils.get_sim_index_schema + +

+ +## ::: ultralytics.data.explorer.utils.sanitize_batch + +

+ +## ::: ultralytics.data.explorer.utils.plot_query_result + +

+ +## ::: ultralytics.data.explorer.utils.prompt_sql_query + +