Deploy SQuADDS ML inference API

README.md

@@ -9,14 +9,73 @@ license: mit
 
 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:
+
+```bash
+curl https://squadds-squadds-ml-inference-api.hf.space/models
+```
+
 ## Included Models
 
+Run a sample prediction:
+
+```bash
+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:
+
+```json
+{
+  "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

deployment_manifest.json

@@ -1,11 +1,13 @@
 {
-  "generated_at": "2026-04-10T23:40:58.854345+00:00",
+  "generated_at": "2026-04-10T23:45:49.011908+00:00",
   "space": {
     "repo_id": "SQuADDS/squadds-ml-inference-api",
     "title": "SQuADDS ML Inference API",
     "sdk": "docker",
     "app_port": 7860,
-    "license": "mit"
+    "license": "mit",
+    "host": "https://squadds-squadds-ml-inference-api.hf.space",
+    "repo_url": "https://huggingface.co/spaces/SQuADDS/squadds-ml-inference-api"
   },
   "models": [
     {
@@ -29,6 +31,48 @@
         "design_options.connection_pads.readout.ground_spacing": "m",
         "design_options.cross_length": "m"
       },
+      "sample_request": {
+        "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
+        }
+      },
       "status": "ready",
       "status_detail": "",
       "tags": [
@@ -52,6 +96,8 @@
       "y_scaler_pattern": "scalers/scaler_y_{name}_one_hot_encoding.save",
       "input_units": {},
       "output_units": {},
+      "sample_request": null,
+      "sample_response": null,
       "status": "missing_model_artifact",
       "status_detail": "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",
       "tags": [
@@ -75,6 +121,8 @@
       "y_scaler_pattern": "scalers/scaler_y_{name}_one_hot_encoding.save",
       "input_units": {},
       "output_units": {},
+      "sample_request": null,
+      "sample_response": null,
       "status": "missing_model_artifact",
       "status_detail": "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",
       "tags": [
@@ -98,6 +146,8 @@
       "y_scaler_pattern": "scalers/scaler_y_{name}_one_hot_encoding.save",
       "input_units": {},
       "output_units": {},
+      "sample_request": null,
+      "sample_response": null,
       "status": "missing_model_artifact",
       "status_detail": "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",
       "tags": [

examples/predict_transmon_hamiltonian_response.json

@@ -0,0 +1,32 @@
+{
+  "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
+  }
+}