maxcembalest commited on
Commit
7196d99
·
1 Parent(s): 31c4cc5

Delete files/arthur-docs-markdown/user-guide/api-query-guide/index.md.txt

Browse files
files/arthur-docs-markdown/user-guide/api-query-guide/index.md.txt DELETED
@@ -1,63 +0,0 @@
1
- # API Query Guide
2
-
3
-
4
- This selection of guides and references covers the basics of querying data using the Arthur Query API Endpoints.
5
- The complete reference for the full Arthur API documentation can be found
6
- [here](https://docs.arthur.ai/api-documentation/v3-api-docs.html),
7
- and the reference to the Query Endpoint can be found
8
- [here](https://docs.arthur.ai/api-documentation/v3-api-docs.html#tag/query).
9
-
10
- ## {doc}`Query Quickstart <query_quickstart>`
11
- For beginners to the Arthur Query API, see the {doc}`query_quickstart`
12
- for a basic walkthrough on querying data about your model's performance.
13
-
14
- ## References:
15
-
16
- ### {doc}`Endpoint Overview <endpoint_overview>`
17
- The {doc}`endpoint_overview` covers the structure and parameters of queries
18
- and provides more examples to get started.
19
-
20
- ### {doc}`Model Evaluation Functions <model_evaluation_functions>`
21
- This reference shows the basic metrics needed to evaluate the performance of models (accuracy, confusion matrix, MSE, etc)
22
-
23
- ### {doc}`Data Drift <data_drift>`
24
- This reference shows querying data drift over time,
25
- which is needed to diagnose which changes in data could explain a change in model performance.
26
-
27
- ### {doc}`Explainability </user-guide/api-query-guide/explainability>`
28
- This reference shows how to query explanations for inferences. Whether in terms of features in tabular models,
29
- words in NLP models, or regions of pixels in CV models, explainability offers a rough approximation of
30
- the _how_ and _why_ behind a model's inferences.
31
-
32
- ### {doc}`Aggregation Functions <aggregation_functions>`
33
- This reference shows how to apply aggregators like an _average_ (`avg`) or a _maximum_ (`max`) to a query.
34
-
35
- ### {doc}`Transformation Functions <transformation_functions>`
36
- This reference shows the transformations available within an Arthur query (numerical operations, binning variables,
37
- grouping by time resolution, etc)
38
-
39
- ### {doc}`Composing Functions <composing_functions>`
40
- This reference shows composing functions to fit complex transformations into a single query
41
-
42
- ### {doc}`Subqueries <subqueries>`
43
- This reference shows how to embed queries within queries.
44
-
45
- ## {doc}`Grouped Inference Queries <grouped_inference_queries>`
46
- This guide shows how to query information pertaining to individual instances of data over time.
47
-
48
- ```{toctree}
49
- :maxdepth: 2
50
- :hidden:
51
-
52
- Query Quickstart <query_quickstart>
53
- Endpoint Overview <endpoint_overview>
54
- Model Evaluation Functions <model_evaluation_functions>
55
- Data Drift <data_drift>
56
- Explainability <explainability>
57
- Aggregation <aggregation_functions>
58
- Transformations <transformation_functions>
59
- Composition <composing_functions>
60
- Subqueries <subqueries>
61
- Advanced Example: Unique Identifiers <grouped_inference_queries>
62
-
63
- ```