Skip to content

Add instantiate_function docs #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add instantiate_function docs #259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add instantiate_function docs
  • Loading branch information
@mzhen77
mzhen77 authored May 27, 2022
commit 73dee4d1348f671260362b604c9a1a9cc4b02703
8 changes: 8 additions & 0 deletions docs/src/API/optimization_function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ The choices for the auto-AD fill-ins with quick descriptions are:

The following sections describe the Auto-AD choices in detail.

### Using instantiate_function

`instantiate_function()` builds the closures required for the calls to exist without the `p` parameters as part of it, which is required by many of the optimizers. For example,

```julia
GalacticOptim.instantiate_function(f, p, adtype, nothing)
```

### AutoForwardDiff

This uses the [ForwardDiff.jl](https://github.com/JuliaDiff/ForwardDiff.jl)
Expand Down