nemos.solvers.get_solver_documentation

nemos.solvers.get_solver_documentation(solver, show_help=False)

Get the documentation of a specified solver, including accepted arguments and the docstring of its __init__.

Parameters:

• solver (Union[str, Type]) – solver can be a string or a type (e.g. nemos.solvers.JaxoptGradientDescent). If solver is a string, the corresponding solver will be read from the solver registry.

• show_help (bool) – Instead of the docstring, show the full output that would be produced by help(solver) where solver is a type.

Return type:

str

Example

>>> import nemos as nmo
>>> print(nmo.solvers.get_solver_documentation("SVRG"))
Showing docstring of nemos.solvers._svrg.WrappedSVRG.
For potentially more info, use `show_help=True`.

Adapter for NeMoS's implementation of SVRG following the AbstractSolver interface.

Accepted arguments:
-------------------
- batch_size
- fun
- has_aux
- init_params
- key
- maxiter
- stepsize
- tol

SVRG's documentation:
...