Replace epsilon with epsilon / 2 (#83)

gdalle · web-flow · commit 44a305508c5f · 2023-07-03T17:24:48.000+02:00
* Replace epsilon with epsilon / 2

* Patch version

* Fix tutorial
diff --git a/CITATION.bib b/CITATION.bib
@@ -2,7 +2,7 @@ @misc{InferOpt.jl
 	author  = {Guillaume Dalle, Léo Baty, Louis Bouvier and Axel Parmentier},
 	title   = {InferOpt.jl},
 	url     = {https://github.com/axelparmentier/InferOpt.jl},
-	version = {v0.5.0},
+	version = {v0.5.1},
 	year    = {2023},
 	month   = {7}
 }
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "InferOpt"
 uuid = "4846b161-c94e-4150-8dac-c7ae193c601f"
 authors = ["Guillaume Dalle", "Léo Baty", "Louis Bouvier", "Axel Parmentier"]
-version = "0.5.0"
+version = "0.5.1"
 
 [deps]
 ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
diff --git a/docs/Manifest.toml b/docs/Manifest.toml
@@ -407,7 +407,7 @@ version = "0.4.10"
 deps = ["ChainRulesCore", "LinearAlgebra", "Random", "Statistics", "StatsBase", "ThreadsX"]
 path = ".."
 uuid = "4846b161-c94e-4150-8dac-c7ae193c601f"
-version = "0.5.0-DEV"
+version = "0.5.1"
 
     [deps.InferOpt.extensions]
     InferOptFrankWolfeExt = "DifferentiableFrankWolfe"
diff --git a/examples/tutorial.jl b/examples/tutorial.jl
@@ -96,7 +96,7 @@ Here is the crucial part where InferOpt.jl intervenes: the choice of a clever lo
 - evaluate the quality of our model based on the paths that it recommends
 =#
 
-layer = PerturbedMultiplicative(linear_maximizer; ε=1.0, nb_samples=5);
+layer = PerturbedMultiplicative(linear_maximizer; ε=0.1, nb_samples=5);
 loss = FenchelYoungLoss(layer);
 
 #=
diff --git a/src/imitation/fenchel_young_loss.jl b/src/imitation/fenchel_young_loss.jl
@@ -105,7 +105,7 @@ function fenchel_young_F_and_first_part_of_grad(
     perturbed::PerturbedMultiplicative, θ::AbstractArray, Z::AbstractArray; kwargs...
 )
     (; maximizer, ε) = perturbed
-    eZ = exp.(ε .* Z .- ε^2)
+    eZ = exp.(ε .* Z .- ε^2 ./ 2)
     θ_perturbed = θ .* eZ
     y = maximizer(θ_perturbed; kwargs...)
     F = dot(θ_perturbed, y)
diff --git a/src/perturbed/multiplicative.jl b/src/perturbed/multiplicative.jl
@@ -52,7 +52,7 @@ function perturb_and_optimize(
     perturbed::PerturbedMultiplicative, θ::AbstractArray, Z::AbstractArray; kwargs...
 )
     (; maximizer, ε) = perturbed
-    θ_perturbed = θ .* exp.(ε .* Z .- ε^2)
+    θ_perturbed = θ .* exp.(ε .* Z .- ε^2 ./ 2)
     y = maximizer(θ_perturbed; kwargs...)
     return y
 end

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ @misc{InferOpt.jl`
`2`	`2`	`author = {Guillaume Dalle, Léo Baty, Louis Bouvier and Axel Parmentier},`
`3`	`3`	`title = {InferOpt.jl},`
`4`	`4`	`url = {https://github.com/axelparmentier/InferOpt.jl},`
`5`		`- version = {v0.5.0},`
	`5`	`+ version = {v0.5.1},`
`6`	`6`	`year = {2023},`
`7`	`7`	`month = {7}`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ function fenchel_young_F_and_first_part_of_grad(`
`105`	`105`	`perturbed::PerturbedMultiplicative, θ::AbstractArray, Z::AbstractArray; kwargs...`
`106`	`106`	`)`
`107`	`107`	`(; maximizer, ε) = perturbed`
`108`		`- eZ = exp.(ε .* Z .- ε^2)`
	`108`	`+ eZ = exp.(ε .* Z .- ε^2 ./ 2)`
`109`	`109`	`θ_perturbed = θ .* eZ`
`110`	`110`	`y = maximizer(θ_perturbed; kwargs...)`
`111`	`111`	`F = dot(θ_perturbed, y)`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ function perturb_and_optimize(`
`52`	`52`	`perturbed::PerturbedMultiplicative, θ::AbstractArray, Z::AbstractArray; kwargs...`
`53`	`53`	`)`
`54`	`54`	`(; maximizer, ε) = perturbed`
`55`		`- θ_perturbed = θ .* exp.(ε .* Z .- ε^2)`
	`55`	`+ θ_perturbed = θ .* exp.(ε .* Z .- ε^2 ./ 2)`
`56`	`56`	`y = maximizer(θ_perturbed; kwargs...)`
`57`	`57`	`return y`
`58`	`58`	`end`