README.md

metadata

title: SQuADDS ML Inference API
sdk: docker
app_port: 7860
license: mit

SQuADDS ML Inference API

Auto-generated deployment bundle for serving ML_qubit_design models with a FastAPI app.

Live URLs

• Space repo: https://huggingface.co/spaces/SQuADDS/squadds-ml-inference-api
• Space host: https://squadds-squadds-ml-inference-api.hf.space

Endpoints

• GET /health
• GET /models
• POST /predict

Quickstart

List models:

curl https://squadds-squadds-ml-inference-api.hf.space/models

Included Models

Run a sample prediction:

curl -X POST \
  https://squadds-squadds-ml-inference-api.hf.space/predict \
  -H 'Content-Type: application/json' \
  -d '{"model_id": "transmon_cross_hamiltonian_inverse", "inputs": {"qubit_frequency_GHz": 4.85, "anharmonicity_MHz": -205.0}, "options": {"include_scaled_outputs": false}}'

Sample response:

{
  "model_id": "transmon_cross_hamiltonian_inverse",
  "display_name": "TransmonCross Hamiltonian to Geometry",
  "predictions": [
    {
      "design_options.connection_pads.readout.claw_length": 0.00011072495544794947,
      "design_options.connection_pads.readout.ground_spacing": 4.571595582092414e-06,
      "design_options.cross_length": 0.0002005973074119538
    }
  ],
  "metadata": {
    "input_order": [
      "qubit_frequency_GHz",
      "anharmonicity_MHz"
    ],
    "output_order": [
      "design_options.connection_pads.readout.claw_length",
      "design_options.connection_pads.readout.ground_spacing",
      "design_options.cross_length"
    ],
    "input_units": {
      "qubit_frequency_GHz": "GHz",
      "anharmonicity_MHz": "MHz"
    },
    "output_units": {
      "design_options.connection_pads.readout.claw_length": "m",
      "design_options.connection_pads.readout.ground_spacing": "m",
      "design_options.cross_length": "m"
    },
    "num_predictions": 1
  }
}

• transmon_cross_hamiltonian_inverse: Inverse model that predicts TransmonCross geometry parameters from target Hamiltonian values.

Skipped Models

• transmon_cross_cap_matrix_inverse: No model checkpoint found. Expected one of: model/best_keras_model_one_hot_encoding.keras, model/best_keras_model_surrogate_defined_loss.keras, model/best_keras_model_model2_surrogate.keras
• coupler_ncap_cap_matrix_inverse: No model checkpoint found. Expected one of: model/best_keras_model_one_hot_encoding.keras, model/best_keras_model_surrogate_defined_loss.keras, model/best_keras_model_model2_surrogate.keras
• cavity_claw_route_meander_inverse: No model checkpoint found. Expected one of: model/best_keras_model_one_hot_encoding.keras, model/best_keras_model_surrogate.keras, model/best_keras_model_model2_surrogate.keras