Repository navigation
Uniform tracing, loss and optimizer keywords (tmax, n_save, rtol/atol, max_nfev, tol) - #231
Open
rogeriojorge wants to merge 8 commits into
Open
rogeriojorge wants to merge 8 commits into
rogeriojorge wants to merge 8 commits into
Conversation
…BdotN row of the API table
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
One name per concept across
Tracing, the loss functions,trace_boozer,trace_field_lines,connection_lengthand the optimizers. Breaking, no aliases; the old -> new table is in the README ("API changes").Tracing(maxtime), loss functionsmaxtimetmax(attributeTracing.tmaxtoo)Tracing(times_to_trace), loss functionsnum_steps,trace_field_lines(samples)n_savetoleranceintrace_boozer,trace_field_lines,connection_length;trace_tolerancein the loss functionsrtol, withatol=Nonemeaningatol = rtoloptimize_loss_function(maximum_function_evaluations)and theMultiObjectiveOptimizeroptionmax_nfevoptimize_loss_function(tolerance_optimization)and theMultiObjectiveOptimizeroptiontolloss_BdotN,loss_BdotN_constraintloss_bdotn,loss_bdotn_constraintTracing(condition=...)stopping_criteria(one callable or a list);conditionwas a second spelling of the same optionOther changes:
Tracingsignature is nowTracing(field, particles, initial_conditions, *, ...): every option is keyword-only.timestepis annotatedfloat | None.atolandmax_steps.trace_boozeradaptive error control:atolbounds the sqrt(s), theta and zeta error,rtoltimes the speed bounds v_par. Withatol=Nonethis is exactly the oldtolerancebehaviour.trace_tolerancelocals in the SIMSOPT comparison examples are nowrtol_*.essos/__main__.pywas callingTracingwithtimestepsandtol_step_size, which no longer exist; it now usesn_saveandrtol.Stacked on #207, so the base is
tracing-defaults. Call sites in essos, tests, examples, docs and README are updated.Tests (CPU, office): The only failures (8) are environment ones that do not touch these changes (old optimistix without
LBFGS, missingf90nml); the rest pass. Ran the field-line, guiding-center, Boozer-vs-VMEC and coil-optimization examples.