Skip to content

Commit 2b22dfe

Browse files
format
1 parent 63cf8cb commit 2b22dfe

File tree

3 files changed

+17
-7
lines changed

3 files changed

+17
-7
lines changed

NEWS.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# v4 Breaking changes
22

3-
1. The main change in this breaking release has been the way mini-batching is handled. The data argument in the solve call and the implicit iteration of that in the callback has been removed,
4-
the stochastic solvers (Optimisers.jl and Sophia) now handle it explicitly. You would now pass in a DataLoader to OptimizationProblem as the second argument to the objective etc (p) if you
5-
want to do minibatching, else for full batch just pass in the full data.
3+
1. The main change in this breaking release has been the way mini-batching is handled. The data argument in the solve call and the implicit iteration of that in the callback has been removed,
4+
the stochastic solvers (Optimisers.jl and Sophia) now handle it explicitly. You would now pass in a DataLoader to OptimizationProblem as the second argument to the objective etc (p) if you
5+
want to do minibatching, else for full batch just pass in the full data.
66

7-
2. The support for extra returns from objective function has been removed. Now the objective should only return a scalar loss value, hence callback doesn't take extra arguments other than the state and loss value.
8-
9-
7+
2. The support for extra returns from objective function has been removed. Now the objective should only return a scalar loss value, hence callback doesn't take extra arguments other than the state and loss value.

docs/src/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,11 @@ to add the specific wrapper packages.
171171
- Unconstrained: ✅
172172
</details>
173173
```
174+
174175
🟡 = supported in downstream library but not yet implemented in `Optimization.jl`; PR to add this functionality are welcome
175176

176177
## Citation
178+
177179
```
178180
@software{vaibhav_kumar_dixit_2023_7738525,
179181
author = {Vaibhav Kumar Dixit and Christopher Rackauckas},
@@ -185,37 +187,48 @@ to add the specific wrapper packages.
185187
url = {https://doi.org/10.5281/zenodo.7738525},
186188
year = 2023}
187189
```
190+
188191
## Reproducibility
192+
189193
```@raw html
190194
<details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
191195
```
196+
192197
```@example
193198
using Pkg # hide
194199
Pkg.status() # hide
195200
```
201+
196202
```@raw html
197203
</details>
198204
```
205+
199206
```@raw html
200207
<details><summary>and using this machine and Julia version.</summary>
201208
```
209+
202210
```@example
203211
using InteractiveUtils # hide
204212
versioninfo() # hide
205213
```
214+
206215
```@raw html
207216
</details>
208217
```
218+
209219
```@raw html
210220
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
211221
```
222+
212223
```@example
213224
using Pkg # hide
214225
Pkg.status(; mode = PKGMODE_MANIFEST) # hide
215226
```
227+
216228
```@raw html
217229
</details>
218230
```
231+
219232
```@eval
220233
using TOML
221234
using Markdown

lib/OptimizationOptimJL/src/OptimizationOptimJL.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,6 @@ function SciMLBase.__solve(cache::OptimizationCache{
292292
else
293293
fg! = cache.f.fg
294294
end
295-
296295

297296
gg = function (G, θ)
298297
cache.f.grad(G, θ)

0 commit comments

Comments
 (0)