Advanced Micro Devices Performance API

Performance counters and profiling data

OpenAPI Specification

advanced-micro-devices-performance-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: AMD Developer Cloud Configuration Performance API
  description: The AMD Developer Cloud API provides access to AMD Instinct GPU instances for AI inference, training, and HPC workloads. Supports managing compute instances, deploying AI models, monitoring GPU utilization, and integrating with ROCm-compatible frameworks including PyTorch, TensorFlow, and vLLM.
  version: '1'
  contact:
    name: AMD Developer Support
    url: https://developer.amd.com/support/
  termsOfService: https://www.amd.com/en/legal/terms-and-conditions.html
  license:
    name: AMD Terms and Conditions
    url: https://www.amd.com/en/legal/terms-and-conditions.html
servers:
- url: https://api.developer.amd.com/v1
  description: AMD Developer Cloud API Production
security:
- apiKey: []
tags:
- name: Performance
  description: Performance counters and profiling data
paths:
  /devices/{deviceId}/performance:
    get:
      operationId: getDevicePerformance
      summary: AMD ROCm Get GPU Device Performance Counters
      description: Retrieve GPU utilization, memory bandwidth, compute throughput, and other performance counters for an AMD GPU.
      tags:
      - Performance
      parameters:
      - name: deviceId
        in: path
        required: true
        description: GPU device identifier.
        schema:
          type: string
      responses:
        '200':
          description: GPU performance counters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevicePerformance'
              examples:
                getDevicePerformance200Example:
                  summary: Default getDevicePerformance 200 response
                  x-microcks-default: true
                  value:
                    deviceId: gpu0
                    gpuUtilization: 92.3
                    memoryUtilization: 78.5
                    memoryBandwidth: 4800.0
                    computeThroughput: 1.83
        '404':
          description: Device not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                getDevicePerformance404Example:
                  summary: Default getDevicePerformance 404 response
                  x-microcks-default: true
                  value:
                    code: NOT_FOUND
                    message: Device not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DevicePerformance:
      type: object
      description: Performance counters for an AMD GPU device.
      properties:
        deviceId:
          type: string
          description: Device identifier.
          example: gpu0
        gpuUtilization:
          type: number
          format: float
          description: GPU compute utilization percentage.
          example: 92.3
        memoryUtilization:
          type: number
          format: float
          description: GPU memory utilization percentage.
          example: 78.5
        memoryBandwidth:
          type: number
          format: float
          description: Memory bandwidth utilization in GB/s.
          example: 4800.0
        computeThroughput:
          type: number
          format: float
          description: Compute throughput in PFLOPS.
          example: 1.83
    ErrorResponse:
      type: object
      description: API error response.
      properties:
        code:
          type: string
          description: Error code.
          example: NOT_FOUND
        message:
          type: string
          description: Error message.
          example: The requested resource was not found.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key