> ## Documentation Index
> Fetch the complete documentation index at: https://docs.infercrane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Compare two analyzed GPU profile captures behind an endpoint, for example before and after a rollout



## OpenAPI

````yaml /openapi.json get /api/v1/endpoints/{name}/gpu-profiles/compare
openapi: 3.1.0
info:
  description: >-
    Durable, authenticated control-plane operations. Mutation responses may
    outlive the requesting client.
  title: InferCrane Control API
  version: 1.0.0
servers:
  - description: Local InferCrane API and gateway
    url: http://127.0.0.1:18000
security: []
tags:
  - name: Admission
  - name: Adoption
  - name: Agents
  - name: Alerts
  - name: Async inference
  - name: Audit
  - name: Autopilot
  - name: Benchmarks
  - name: Billing
  - name: Billing administration
  - name: Burst Guard
  - name: Capacity intelligence
  - name: Compute
  - name: Context Passport
  - name: Deployments
  - name: Diagnostics
  - name: Endpoints
  - name: External capacity
  - name: FinOps
  - name: Identity
  - name: Inference
  - name: Inference Lab
  - name: Inference decisions
  - name: Inference optimization
  - name: Infrastructure
  - name: Marketplace administration
  - name: Model API administration
  - name: Model APIs
  - name: Model artifacts
  - name: Model catalog
  - name: Monitoring
  - name: Notifications
  - name: Operations
  - name: Planning
  - name: Providers
  - name: Recipes
  - name: Release Guard
  - name: Release evidence
  - name: Replay
  - name: Revisions
  - name: Routing
  - name: Sandboxes
  - name: Scaling
  - name: Secrets
  - name: System
  - name: Targets
  - name: Training lineage
paths:
  /api/v1/endpoints/{name}/gpu-profiles/compare:
    get:
      tags:
        - Monitoring
      summary: >-
        Compare two analyzed GPU profile captures behind an endpoint, for
        example before and after a rollout
      operationId: compareEndpointGPUProfiles
      parameters:
        - in: path
          name: name
          required: true
          schema:
            minLength: 1
            type: string
        - description: The earlier capture, for example the starting point.
          in: query
          name: base
          required: true
          schema:
            pattern: ^gpc-[0-9a-f]{32}$
            type: string
        - description: The later capture, for example after an optimization rolled out.
          in: query
          name: head
          required: true
          schema:
            pattern: ^gpc-[0-9a-f]{32}$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GPUProfileComparison'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Typed API error
      security:
        - bearerAuth: []
components:
  schemas:
    GPUProfileComparison:
      additionalProperties: false
      properties:
        base:
          $ref: '#/components/schemas/GPUProfileSummary'
        categories:
          items:
            additionalProperties: false
            properties:
              base_ms_per_s:
                minimum: 0
                type: number
              base_share:
                maximum: 1
                minimum: 0
                type: number
              category:
                enum:
                  - attention
                  - gemm
                  - communication
                  - memory
                  - norm
                  - activation
                  - sampling
                  - other
                type: string
              head_ms_per_s:
                minimum: 0
                type: number
              head_share:
                maximum: 1
                minimum: 0
                type: number
            required:
              - base_ms_per_s
              - base_share
              - category
              - head_ms_per_s
              - head_share
            type: object
          maxItems: 8
          type: array
        head:
          $ref: '#/components/schemas/GPUProfileSummary'
        kernels:
          items:
            additionalProperties: false
            properties:
              base_ms_per_s:
                minimum: 0
                type:
                  - number
                  - 'null'
              category:
                enum:
                  - attention
                  - gemm
                  - communication
                  - memory
                  - norm
                  - activation
                  - sampling
                  - other
                type: string
              head_ms_per_s:
                minimum: 0
                type:
                  - number
                  - 'null'
              name:
                type: string
            required:
              - base_ms_per_s
              - category
              - head_ms_per_s
              - name
            type: object
          maxItems: 15
          type: array
        metrics:
          items:
            additionalProperties: false
            properties:
              base:
                type:
                  - number
                  - 'null'
              better:
                enum:
                  - higher
                  - lower
                  - ''
                type: string
              delta:
                type:
                  - number
                  - 'null'
              head:
                type:
                  - number
                  - 'null'
              improved:
                description: >-
                  Null when either side is unknown or the change is within two
                  points or two percent.
                type:
                  - boolean
                  - 'null'
              label:
                type: string
              metric:
                type: string
              unit:
                type: string
            required:
              - base
              - better
              - delta
              - head
              - improved
              - label
              - metric
              - unit
            type: object
          maxItems: 32
          type: array
        warnings:
          items:
            type: string
          maxItems: 8
          type: array
      required:
        - base
        - categories
        - head
        - kernels
        - metrics
        - warnings
      type: object
    ErrorEnvelope:
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
      type: object
    GPUProfileSummary:
      additionalProperties: false
      properties:
        accelerator:
          type:
            - string
            - 'null'
        active:
          description: The capture belongs to the deployment's serving revision.
          type: boolean
        busy_share:
          maximum: 1
          minimum: 0
          type:
            - number
            - 'null'
        deployment:
          type: string
        ended_at:
          format: date-time
          type: string
        gpus:
          type:
            - integer
            - 'null'
        id:
          pattern: ^gpc-[0-9a-f]{32}$
          type: string
        recorded_at:
          format: date-time
          type: string
        revision:
          minimum: 1
          type: integer
        schema_version:
          type: string
        started_at:
          format: date-time
          type: string
        tool:
          type: string
        tool_version:
          type: string
        verdict:
          oneOf:
            - type: 'null'
            - additionalProperties: false
              properties:
                bottleneck:
                  enum:
                    - host-launch
                    - communication
                    - memory-bandwidth
                    - compute
                    - attention
                    - busy
                    - unknown
                  type: string
                evidence:
                  description: The measured values the sentence rests on.
                  maxLength: 400
                  type: string
                sentence:
                  maxLength: 280
                  minLength: 1
                  type: string
              required:
                - bottleneck
                - evidence
                - sentence
              type: object
      required:
        - accelerator
        - active
        - busy_share
        - deployment
        - ended_at
        - gpus
        - id
        - recorded_at
        - revision
        - schema_version
        - started_at
        - tool
        - tool_version
        - verdict
      type: object
    Error:
      properties:
        category:
          type: string
        code:
          type: string
        message:
          type: string
        remediation:
          type: string
        request_id:
          type: string
        retryable:
          type: boolean
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.