Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/mvp_demo' into listRecommend-real
Browse files Browse the repository at this point in the history
Signed-off-by: Dinakar Guniguntala <[email protected]>
  • Loading branch information
dinogun committed Feb 21, 2023
2 parents 0a0bce6 + 5c92ec2 commit b3fc2f8
Show file tree
Hide file tree
Showing 51 changed files with 1,704 additions and 928 deletions.
66 changes: 0 additions & 66 deletions design/CreatePerformanceProfile.md

This file was deleted.

38 changes: 30 additions & 8 deletions design/ExperimentModeAPI.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Experiment Monitoring Mode
This article describes how to quickly get started with the Local cluster Experimental Mode use case REST API using curl command.

## listStacks
This article describes how to quickly get started with the Local cluster Experimental Mode use case REST API using curl
command.

**Note :** The ISO 8601 standard underpins all timestamp formats. An example of a valid timestamp in this format is
2022-01-23T18:25:43.511Z, which represents January 23, 2022, at 18:25:43.511 UTC.

## listStacks

Get the list of application stacks monitored by autotune.

**Request**
Expand All @@ -12,6 +18,7 @@ Get the list of application stacks monitored by autotune.
`curl -H 'Accept: application/json' http://<URL>:<PORT>/listStacks?experiment_name=<EXPERIMENT_NAME>`

**Response**

```
[
{
Expand Down Expand Up @@ -42,6 +49,7 @@ Get the list of application stacks monitored by autotune.
```

## listStackLayers

Returns the list of application stacks monitored by autotune along with layers detected in the stacks.

**Request**
Expand All @@ -52,6 +60,7 @@ Returns the list of application stacks monitored by autotune along with layers d
`curl -H 'Accept: application/json' http://<URL>:<PORT>/listStackLayers?experiment_name=<EXPERIMENT_NAME>`

**Response**

```
[
{
Expand Down Expand Up @@ -113,18 +122,22 @@ Returns the list of application stacks monitored by autotune along with layers d
]
```

## listStackTunables
## listStackTunables

Returns the list of application stacks monitored by autotune along with their tunables.
**Request**
`GET /listStackTunables` gives the tunables and layer information for all the application stacks monitored by autotune.

`GET /listStackTunables?experiment_name=<EXPERIMENT_NAME>` for getting the tunables information of a specific application.
`GET /listStackTunables?experiment_name=<EXPERIMENT_NAME>` for getting the tunables information of a specific
application.

`GET /listStackTunables?experiment_name=<EXPERIMENT_NAME>&layer_name=<LAYER>` for getting tunables of a specific layer for the application.
`GET /listStackTunables?experiment_name=<EXPERIMENT_NAME>&layer_name=<LAYER>` for getting tunables of a specific layer
for the application.

`curl -H 'Accept: application/json' http://<URL>:<PORT>/listStackTunables?experiment_name=<EXPERIMENT_NAME>`

**Response**

```
[
{
Expand Down Expand Up @@ -174,7 +187,9 @@ Returns the list of application stacks monitored by autotune along with their tu
}
]
```
## listAutotuneTunables

## listAutotuneTunables

Get the tunables supported by autotune for the SLO.

**Request**
Expand All @@ -187,6 +202,7 @@ Get the tunables supported by autotune for the SLO.
`curl -H 'Accept: application/json' http://<URL>:<PORT>/listAutotuneTunables?slo_class=<SLO_CLASS>`

**Response**

```
[
{
Expand Down Expand Up @@ -261,7 +277,9 @@ Get the tunables supported by autotune for the SLO.
}
]
```
## SearchSpace

## SearchSpace

Generates the search space used for the analysis.

**Request**
Expand Down Expand Up @@ -331,13 +349,16 @@ Generates the search space used for the analysis.
}
]
```
## CreateExperimentTrial

## CreateExperimentTrial

Create experiment trials using input JSON provided by Analyser module.

**Request**
`POST /createExperimentTrial`

`curl -H 'Accept: application/json' -X POST --data 'copy paste below JSON' http://<URL>:<PORT>/createExperimentTrial`

```
[{
"settings": {
Expand Down Expand Up @@ -458,6 +479,7 @@ Create experiment trials using input JSON provided by Analyser module.
```

**Response**

```
{
"message": "Experiment trial registered successfully with Autotune. View registered experiments at /listExperiments",
Expand Down
Loading

0 comments on commit b3fc2f8

Please sign in to comment.