boss_bench.models.inverse_design#
Inverse-design model: generate plasma boundaries with chosen properties.
- class boss_bench.models.inverse_design.InverseDesignModel(*args, **kwargs)[source]#
The Diffusion baseline of the paper’s inverse-design task: generate plasma boundaries with desired properties.
The model generates the plasma boundary of a configuration from properties it should have, by conditional flow matching. The inputs are these properties, under the names of the BoSS fields and in their units:
nfp: the number of field periods, from 1 to 6.loss_fraction: the fraction of the alpha particles born on \(s = 0.1\) that are lost, asconfinement.loss_fractioncomputes it.toroidal_flux_edge: the toroidal flux enclosed by the boundary [Wb].minor_radius: the effective minor radius of the boundary [m].aspect_ratio: the aspect ratio.min_modB: the minimum field strength [T].mirror_ratio: the mirror ratio, \(B_\text{max} / B_\text{min}\).pressure: the pressure profile [Pa], shape(15,), on the radial grids1d, 15 points from \(s = 10^{-4}\) to 1.iota: the rotational transform, shape(15,), on the same grid.vmec_ncurr: 0 if the equilibrium is computed with theiotaprofile, 1 if with the current profile.
The output is a plasma boundary laid out as the field
boundary_xyz: shape(41 * 41 * 3,), or(41, 41, 3)indexed \((\phi, \theta, xyz)\), with 41 toroidal angles uniformly spaced in \([0, 2\pi / n_\text{fp})\) and 41 poloidal angles uniformly spaced in \([0, 2\pi)\), endpoints excluded.Load the model with
load, and generate withsample. Each call draws new boundaries; they are not differentiable with respect to the properties.Example
Generate a boundary with the properties of a test configuration, but a tenth of its loss fraction:
import h5py import boss_bench as bb from boss_bench import models from boss_bench.models import InverseDesignModel path = models.download("inverse_design", "BoSS-models/inverse_design") model = InverseDesignModel.load(path) with h5py.File(bb.list_files("BoSS", "confinement", "test")[0], "r") as f: record = bb.load_record(f, 0) conditions = {name: record[name] for name in models.inverse_design.CONDITIONS if name != "loss_fraction"} loss_fraction = bb.loss_fraction(record["confinement_time"], record["t_max"], record["s_init"]) boundary_xyz = model.sample({**conditions, "loss_fraction": 0.1 * loss_fraction}, seed=0)
- classmethod load(path, device='cpu')[source]#
Load the trained model, from its PyTorch weights.
This loads
model.safetensors. The ONNX export of the model, from the same Hugging Face folder, is not loaded here: run it with ONNX Runtime instead.- Parameters:
path (str) – the model’s folder, holding
config.jsonandmodel.safetensors, e.g. frommodels.download("inverse_design", path).device (str or torch.device) – the device to put the model on.
- Returns:
the model, ready to generate.
- Return type:
- Raises:
ValueError – if the folder holds another model.
- sample(conditions, seed=None)#
Generate one boundary per set of properties.
- Parameters:
conditions (dict) – the properties of one design, or of several, with one row per design:
nfp,loss_fraction,toroidal_flux_edge,minor_radius,aspect_ratio,min_modB,mirror_ratio,pressure,iotaandvmec_ncurr. To ask for several designs with the same properties, repeat the rows.seed (int, optional) – the random seed. By default, a random one.
- Returns:
the boundary points [m], laid out as the field
boundary_xyz, shape(41 * 41 * 3,), or(n, 41 * 41 * 3)for several designs.- Return type:
np.ndarray
- Raises:
KeyError – if a property is missing.
ValueError – if a property contains NaN or inf, or
nfpis not between 1 and 6.