Skip to content
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

Jump to bottom

Documentation revamp #102

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Documentation revamp #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9372afd
Add DocStringExtensions dependency
BatyLeo Dec 12, 2023
df18d7d
update docstrings with extension package
BatyLeo Dec 12, 2023
32d16dd
fix failing doc
BatyLeo Dec 12, 2023
d0d1c3b
restructure API reference section
BatyLeo Dec 13, 2023
f3615eb
try to use plots in documentation
BatyLeo Dec 14, 2023
67c334c
update
BatyLeo Dec 14, 2023
cdb687c
update
BatyLeo Jan 8, 2024
9417d32
update background with a more general setting
BatyLeo Jan 15, 2024
20ff86e
tutorial on argmax
BatyLeo Jan 17, 2024
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
2 changes: 2 additions & 0 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ version = "0.6.1"
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
DensityInterface = "b429d917-457f-4dbc-8f4c-0cc954292b1d"
DifferentiableFrankWolfe = "b383313e-5450-4164-a800-befbd27b574d"
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
RequiredInterfaces = "97f35ef4-7bc5-4ec1-a41a-dcc69c7308c6"
Expand All @@ -25,6 +26,7 @@ InferOptFrankWolfeExt = "DifferentiableFrankWolfe"
ChainRulesCore = "1"
DensityInterface = "0.4.0"
DifferentiableFrankWolfe = "0.2"
DocStringExtensions = "0.9"
LinearAlgebra = "<0.0.1,1"
Random = "<0.0.1,1"
RequiredInterfaces = "0.1.3"
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@
InferOpt.jl is a toolbox for using combinatorial optimization algorithms within machine learning pipelines.

It allows you to create differentiable layers from optimization oracles that do not have meaningful derivatives.
Typical examples include mixed integer linear programs or graph algorithms.
Typical examples include mixed integer linear programs or graph algorithms, but any discrete function is compatible.

## Getting started

To install the stable version, open a Julia REPL and run the following command:

```julia
julia> using Pkg; Pkg.add("InferOpt")
julia> import Pkg; Pkg.add("InferOpt")
```

To install the development version, run this command instead:

```julia
julia> using Pkg; Pkg.add(url="https://github.com/axelparmentier/InferOpt.jl")
julia> import Pkg; Pkg.add(url="https://github.com/axelparmentier/InferOpt.jl")
```

## Citing us
Expand Down
Loading
Loading