amplify.client.ToshibaClientParameters¶
- class ToshibaClientParameters¶
A parameter class for the Toshiba client in Fixstars Amplify SDK. For more information, see the Calculation parameters section of Simulated Bifurcation Machine User Manual .
- __init__(*args, **kwargs)¶
Methods
__init__
(*args, **kwargs)Attributes
A parameter for the calculation.
A parameter for selecting the algorithm for calculation.
The number of steps in the deeper algorithm (simulated annealing method).
Specifies the time differential between one step and the next in calculation.
Specifies the number of loops in SBM calculation.
Specifies the maximum number of output solutions.
Specifies the maximum waiting time in seconds for each request.
Specifies the strategy for calculation.
Specifies how to output statistical information.
Specifies the number of steps in SBM calculation.
Specifies the end condition of calculation.
Specifies the maximum calculation time in seconds.
- property C¶
A parameter for the calculation. For the definition, see \(\xi_0\) in Goto, Tatsumura, & Dixon (2019, p. 2) . Specified by a positive floating point number. If set to 0, the constant C is automatically determined and applied to calculation.
- Type
- property algo¶
A parameter for selecting the algorithm for calculation.
\(1.5\): bSBM algorithm is selected.
\(2.0\): dSBM algorithm is selected.
Assumed 2.0 if no value is specified.
- Type
- property dt¶
Specifies the time differential between one step and the next in calculation. Specified as a positive floating point number. Assumed 1.0 if it is not specified.
- Type
- property loops¶
Specifies the number of loops in SBM calculation. SBM searches for a better solution through repeated calculations. If 0 is specified, calculation will be repeated to the maximum calculation time. Assumed 1 if no value is specified.
- Type
- property maxout¶
Specifies the maximum number of output solutions. With maxout as the upper limit, the solutions found are output in order from the one with the best value of the objective function. The maximum possible value is 1000.
- Type
- property maxwait¶
Specifies the maximum waiting time in seconds for each request. If time specified by maxwait passes during the wait in a queue, the request ends with a timeout error.
- Type
- property prefer¶
Specifies the strategy for calculation. Select
"speed"
or"auto"
."speed"
: A setup where calculation time is prioritized over accuracy."auto"
: A standard setup.
- Type
- property stats¶
Specifies how to output statistical information. Specify one from
"none"
,"summary"
, or"full"
."none"
: outputs nothing."summary"
: outputs the average, standard deviation, and the best frequency."full"
: outputs the average, standard deviation, and a histogram.
- Type
- property steps¶
Specifies the number of steps in SBM calculation. The value 0 means automatic setup where the number of steps is dynamically determined. Assumed 0 if no value is specified.
- Type
- property target¶
Specifies the end condition of calculation. The calculation will stop when the value of the objective function reaches the target value.
- Type