Skip to content

Commit 9fb3c88

Browse files
committed
Document JIT compiler switch
1 parent 3243ef5 commit 9fb3c88

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/source/ipopt.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,13 @@ model.set_raw_parameter("linear_solver", "ma27")
6565

6666
## JIT compiler used by Ipopt interface
6767

68+
The interface of Ipopt uses the JIT compiler to compile the nonlinear objective function, constraints and their derivatives. We have two implementations of JIT based on `llvmlite` and `tccbox`(Tiny C Compiler). The default JIT compiler is `llvmlite` and we advise you to use it for better performance brought by optimization capability of LLVM. If you want to use `tccbox`, you can specify `jit="C"` when creating the `ipopt.Model` object.
69+
70+
```python
71+
model = ipopt.Model()
72+
# equivalent to
73+
model = ipopt.Model(jit="LLVM")
74+
75+
# If you want to use tccbox
76+
model = ipopt.Model(jit="C")
77+
```

0 commit comments

Comments
 (0)