SciML / Surrogates.jl

Surrogate modeling and optimization for scientific machine learning (SciML)
https://docs.sciml.ai/Surrogates/stable/
Other
335 stars 69 forks source link

Documentation improvements #239

Open ArnoStrouwen opened 3 years ago

ArnoStrouwen commented 3 years ago

http://surrogates.sciml.ai/dev/optimizations/ http://surrogates.sciml.ai/dev/surrogate/ http://surrogates.sciml.ai/dev/samples/

ludoro commented 3 years ago

Thanks for the comments Arno, will look into it in the weekend. As for your point number three, it's true and I should write that more explicitly.

ArnoStrouwen commented 3 years ago
maxkapur commented 3 years ago

The surrogate_optimize() function seems underdocumented as well. Only some of the methods listed in the documentation have docstrings, and it is not clear what I am suppose to pass as the second argument (e.g. ::DYCORS).

I could only find one example in the docs that actually calls surrogate_optimize(), and it passes a function RTEA as the second argument, which is itself undocumented.

Spinachboul commented 11 months ago

RTEA: Real Time Evolutionary Algorithm. Its one of the optimization techniques used to handle functions with expensive evaluations.

@maxkapur This feature should be documented in the official along with a brief description of its arguements.