From fb3101263b2911c07c830d14ff451bfd29bffbd6 Mon Sep 17 00:00:00 2001 From: Vaibhav Kumar Dixit Date: Tue, 19 Dec 2023 20:31:13 -0500 Subject: [PATCH 1/3] Fix docstring refrences optfun and optprob --- src/scimlfunctions.jl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/scimlfunctions.jl b/src/scimlfunctions.jl index e17c2efef..2c354b159 100644 --- a/src/scimlfunctions.jl +++ b/src/scimlfunctions.jl @@ -1988,8 +1988,8 @@ the objective, even if no such parameters are used in the objective it should be any additional arguments that are relevant to the objective function, for example minibatches used in machine learning, take a look at the minibatching tutorial [here](https://docs.sciml.ai/Optimization/stable/tutorials/minibatch/). This should return a scalar, the loss value, as the first return output and if any additional outputs are returned, they will be passed to the `callback` -function described in [Callback Functions](@ref). -- `adtype`: see the section [Defining Optimization Functions via AD](@ref) +function described in [Callback Functions](https://docs.sciml.ai/Optimization/stable/API/solve/#Common-Solver-Options-(Solve-Keyword-Arguments)). +- `adtype`: see the Defining Optimization Functions via AD section below. ## Keyword Arguments @@ -2034,7 +2034,7 @@ function described in [Callback Functions](@ref). - `cons_hess_colorvec`: an array of color vector according to the SparseDiffTools.jl definition for the sparsity pattern of the `cons_hess_prototype`. -When [Symbolic Problem Building with ModelingToolkit](@ref) interface is used the following arguments are also relevant: +When [Symbolic Problem Building with ModelingToolkit](https://docs.sciml.ai/Optimization/stable/tutorials/symbolic/) interface is used the following arguments are also relevant: - `syms`: the symbol names for the elements of the equation. This should match `u0` in size. For example, if `u = [0.0,1.0]` and `syms = [:x, :y]`, this will apply a canonical naming to the @@ -4234,4 +4234,4 @@ function SymbolicIndexingInterface.observed(fn::AbstractSciMLFunction, sym::Symb return SymbolicIndexingInterface.observed(fn, getproperty(fn.sys, sym)) end -SymbolicIndexingInterface.constant_structure(::AbstractSciMLFunction) = true \ No newline at end of file +SymbolicIndexingInterface.constant_structure(::AbstractSciMLFunction) = true From d388072112e04563a584a81e1492d1230fe4b8fb Mon Sep 17 00:00:00 2001 From: Vaibhav Kumar Dixit Date: Tue, 19 Dec 2023 20:34:28 -0500 Subject: [PATCH 2/3] Update basic_problems.jl --- src/problems/basic_problems.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/problems/basic_problems.jl b/src/problems/basic_problems.jl index cfed37f16..11a300300 100644 --- a/src/problems/basic_problems.jl +++ b/src/problems/basic_problems.jl @@ -613,7 +613,7 @@ are the lower and upper bounds for `cons[i]`. The `f` in the `OptimizationProblem` should typically be an instance of [`OptimizationFunction`](@ref) to specify the objective function and its derivatives either by passing -predefined functions for them or automatically generated using the [`ADType`](@ref). +predefined functions for them or automatically generated using the [ADType](https://github.com/SciML/ADTypes.jl). If `f` is a standard Julia function, it is automatically transformed into an `OptimizationFunction` with `NoAD()`, meaning the derivative functions are not @@ -639,7 +639,7 @@ Any extra keyword arguments are captured to be sent to the optimizers. ## Inequality and Equality Constraints -Both inequality and equality constraints are defined by the `f.cons` function in the [`OptimizationFunction`](@ref) +Both inequality and equality constraints are defined by the `f.cons` function in the [`OptimizationFunction`](https://docs.sciml.ai/Optimization/stable/API/optimization_function/#optfunction) description of the problem structure. This `f.cons` is given as a function `f.cons(u,p)` which computes the value of the constraints at `u`. For example, take `f.cons(u,p) = u[1] - u[2]`. With these definitions, `lcons` and `ucons` define the bounds on the constraint that the solvers try to satisfy. From c0a239cb68341c0f0ef1fa1dcadec398c3672904 Mon Sep 17 00:00:00 2001 From: Vaibhav Kumar Dixit Date: Tue, 19 Dec 2023 20:34:49 -0500 Subject: [PATCH 3/3] Update Project.toml --- Project.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Project.toml b/Project.toml index 2044cf6be..719690c39 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "SciMLBase" uuid = "0bca4576-84f4-4d90-8ffe-ffa030f20462" authors = ["Chris Rackauckas and contributors"] -version = "2.11.1" +version = "2.11.2" [deps] ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"