tidy3d.plugins.design.MethodRandomCustom

class MethodRandomCustom

Bases: AbstractMethodRandom

Select parameters with an object with a user supplied sampler with a .random method.

Parameters:

• name (Attribute: name) –

  Type	Optional[str]
  Default	= None
  Description	Optional name for the sweep method.

• num_points (Attribute: num_points) –

  Type	PositiveInt
  Default
  Description	Maximum number of sampling points to perform in the sweep.

• sampler (Attribute: sampler) –

  Type	Optional[Any]
  Default	= None
  Description	An object with a .random(n) method, which returns a np.ndarray of shape (n, d) where d is the number of dimensions of the design space. Values must lie between [0, 1] and will be re-scaled depending on the design parameters. Compatible objects include instances of scipy.stats.qmc.QMCEngine, but other objects can also be supplied.

Example

>>> import tidy3d.plugins.design as tdd
>>> import scipy.stats.qmc as qmc
>>> sampler = qmc.Halton(d=3)
>>> method = tdd.MethodRandomCustom(num_points=20, sampler=sampler)

Attributes

Methods

get_sampler(parameters)

Sampler for this Method class.

sampler

get_sampler(parameters)

Sampler for this Method class. If None, sets a default.

__hash__()

Hash method.