All URIs are relative to https://all.api.keil.arm.com
| Method | HTTP request | Description |
|---|---|---|
| GetAnalyser | Get /analysers/{analyserName} | Get analyser description |
| ListAnalysers | Get /analysers/ | List analysers currently available in Perf-AI |
AnalyserItem GetAnalyser(ctx, analyserName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
Get analyser description
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
analyserName := "analyserName_example" // string | Stable unique identifier of the analyser. Note: this identifier is generated by the Perf-AI system.
acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AnalyserAPI.GetAnalyser(context.Background(), analyserName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AnalyserAPI.GetAnalyser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAnalyser`: AnalyserItem
fmt.Fprintf(os.Stdout, "Response from `AnalyserAPI.GetAnalyser`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| analyserName | string | Stable unique identifier of the analyser. Note: this identifier is generated by the Perf-AI system. |
Other parameters are passed through a pointer to a apiGetAnalyserRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AnalyserCollection ListAnalysers(ctx).AcceptVersion(acceptVersion).Clock(clock).Engine(engine).Format(format).Ip(ip).Partner(partner).Profile(profile).Target(target).Tool(tool).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
List analysers currently available in Perf-AI
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
clock := "clock_example" // string | Filter analysers by clock configuration or frequency. (optional)
engine := "engine_example" // string | Filter analysers by execution engine type. (optional)
format := "format_example" // string | Filter analysers by supported model format. (optional)
ip := "ngp" // string | Filter analysers by IP. (optional)
partner := "samsung" // string | Filter analysers by Partner. (optional)
profile := "nx-peak-12sc-8nx-600mhz" // string | Filter analysers by profile identifier. (optional)
target := "target_example" // string | Filter analysers by hardware target. (optional)
tool := "mlia" // string | Filter analysers by tool identifier. (optional)
embed := false // bool | Embedding: The whether or not to embed resources into the collection (rather than return links). (optional) (default to false)
ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)
limit := int32(20) // int32 | Paging: The maximum number of items to return in a resource. (optional) (default to 20)
offset := int32(0) // int32 | Paging: The index of the first item to return in the resource. (optional) (default to 0)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AnalyserAPI.ListAnalysers(context.Background()).AcceptVersion(acceptVersion).Clock(clock).Engine(engine).Format(format).Ip(ip).Partner(partner).Profile(profile).Target(target).Tool(tool).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AnalyserAPI.ListAnalysers``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListAnalysers`: AnalyserCollection
fmt.Fprintf(os.Stdout, "Response from `AnalyserAPI.ListAnalysers`: %v\n", resp)
}Other parameters are passed through a pointer to a apiListAnalysersRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | |
| clock | string | Filter analysers by clock configuration or frequency. | |
| engine | string | Filter analysers by execution engine type. | |
| format | string | Filter analysers by supported model format. | |
| ip | string | Filter analysers by IP. | |
| partner | string | Filter analysers by Partner. | |
| profile | string | Filter analysers by profile identifier. | |
| target | string | Filter analysers by hardware target. | |
| tool | string | Filter analysers by tool identifier. | |
| embed | bool | Embedding: The whether or not to embed resources into the collection (rather than return links). | [default to false] |
| ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. | |
| limit | int32 | Paging: The maximum number of items to return in a resource. | [default to 20] |
| offset | int32 | Paging: The index of the first item to return in the resource. | [default to 0] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]