readme first sketch #2

joaquimg · 2017-12-07T01:51:25Z

Begin fixing #1

blegat · 2017-12-07T10:05:41Z

README.md

@@ -1,2 +1,26 @@
 # LinQuadOptInterface.jl
-Intermediate wrapper for MOI of CPLEX, Gurobi and Xpress
+
+LinQuadOptInterface is a intermediate wrapper designed to bridge low-level Integer Linear and Quadratic solvers. I provides access to many MathOptInterface functionalities mainly related to problem modifications: 


I provides -> It provides.
Maybe also "LinQuadOptInterface" -> "LinQuadOptInterface (LQOI)"

blegat · 2017-12-07T10:06:15Z

README.md

+
+All these modification are caried out by the low-level solver own functionalities and hence it differs from MathOptInterfaceUtilities' `Instance`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.
+
+Here the data in the julia level is minimal, basically only references to constraints and varibles.


"varibles" -> "variables"

mlubin · 2017-12-09T01:31:23Z

README.md

+5. change constraint rhs
+6. change variable bounds and type
+
+All these modification are caried out by the low-level solver own functionalities and hence it differs from MathOptInterfaceUtilities' `Instance`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.


Instance is not an implementation of a solver wrapper, so this is confusing.

mlubin · 2017-12-09T01:31:49Z

README.md

@@ -1,2 +1,26 @@
 # LinQuadOptInterface.jl
-Intermediate wrapper for MOI of CPLEX, Gurobi and Xpress
+
+LinQuadOptInterface (LQOI) is a intermediate wrapper designed to bridge low-level Integer Linear and Quadratic solvers. It provides access to many MathOptInterface functionalities mainly related to problem modifications: 


Designed to make it easier for low-level [...] solvers to implement the MOI interface.

mlubin · 2017-12-20T00:42:24Z

README.md

@@ -1,2 +1,28 @@
 # LinQuadOptInterface.jl
-Intermediate wrapper for MOI of CPLEX, Gurobi and Xpress
+
+LinQuadOptInterface (LQOI) is designed to make it easier for low-level wrapper designed to bridge low-level Integer Linear and Quadratic solvers to implement the MOI interface. It provides access to many MathOptInterface functionalities mainly related to problem modifications: 


The first sentence seems jumbled.

yep, copy and paste mistake

mlubin · 2017-12-20T00:44:22Z

README.md

+
+## LinQuadOptInterface Instance
+
+In the MOI `Instance` made available by LinQuadOptInterface.jl all these modification are caried out by the low-level solver own functionalities and hence it differs from MathOptInterfaceUtilities' `Instance`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.


Instance does not directly connect to solvers. The comparison here is with solver wrappers that use Instance internally.

What about:
The MOI Instance made available by LinQuadOptInterface.jl is used as a standardized interface to a solver which has a low-level wrapper that allows most of (or all) these modification to be made in the solver's internal structures. The data kept in the julia level is minimal.

Solver instance, not instance, right? It differs from other wrappers that store a standalone instance in Julia.

Now I understand what you mean, I will re-do it more clearly

mlubin · 2018-03-09T02:17:09Z

Bump. The readme on master still does not explain what this package does!

joaquimg · 2018-03-10T03:45:55Z

Yep, Some time ago I started that, but then I waited for the big renaming. I will make it a priority.

# Conflicts: # README.md

joaquimg · 2018-03-10T04:33:09Z

@mlubin @blegat @odow comments welcome :)

blegat · 2018-03-10T10:30:44Z

README.md

+
+## LinQuadOptInterface Instance
+
+In LinQuadOptInterface.jl the MOI `AbstractOptimizer` is specified to `LinQuadOptimizer`. In this implementation all the above metioned modifications are caried out by the low-level solver own functionalities and hence it differs from MathOptInterface.Utilities' `AbstractModel`'s generated by the `@model` macro. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.


metioned -> mentioned

You mention @model but the discussion is closen ti CachingOptimizer

Do you have any suggestion about what to say there or should I just remove this part?

You added it when SDOI was keeping a copy but now no optimizer keeps a copy, CachingOptimizer should be used for that. You can say "In this implementation all the above mentioned modifications are carried out by the low-level solver own functionalities and hence the optimizer can be used without a CachingOptimizer"

blegat · 2018-03-10T10:32:22Z

README.md

+
+## Current uses
+
+This package is currently used to implement `MathOptInterfaceXpress.jl`, `MathOptInterfaceCPLEX.jl`, `MathOptInterfaceGurobi.jl` and `MathOptInterfaceGLPK.jl`. The last one being only a integer linear solver.


It would be nice to ahh hyperlinks

Add links, fix typo, add disclaimer

mlubin · 2018-03-10T14:22:26Z

README.md

@@ -1,2 +1,30 @@
 # LinQuadOptInterface.jl
-Intermediate wrapper for MOI of GLPK, CPLEX, Gurobi and Xpress
+
+**Attention**: This is an intermediary layer used by some implementations of the MathOptInterface.


Attention seems unnecessary

mlubin · 2018-03-10T14:23:32Z

README.md

+
+**Attention**: This is an intermediary layer used by some implementations of the MathOptInterface.
+
+LinQuadOptInterface (LQOI) is designed to make it easier for low-level wrapper designed to bridge low-level Integer Linear and Quadratic solvers to implement the [MathOptInterface](https://github.com/JuliaOpt/MathOptInterface.jl) (MOI) interface. It provides access to many MOI functionalities mainly related to problem modifications:


MOI interface is redundant, just say "to implement MathOptInterface (MOI)"

mlubin · 2018-03-10T14:24:18Z

README.md

+
+## LinQuadOptInterface Instance
+
+In LinQuadOptInterface.jl the MOI `AbstractOptimizer` is specialized to `LinQuadOptimizer`. In this implementation all the above mentioned modifications are caried out by the low-level solver own functionalities and hence it differs from MathOptInterface.Utilities' `CachingOptimizer`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.


low-level solver's own

mlubin · 2018-03-10T14:27:31Z

README.md

+3. change constraint coefficients
+4. change constraint type
+5. change constraint rhs
+6. change variable bounds and type


Maybe add a sentence making it explicit that using LQOI is entirely optional and comes with a trade-off of introducing an extra abstraction layer between the solver and MOI.

odow · 2018-03-10T21:07:53Z

README.md

+
+## LinQuadOptInterface Optimizer
+
+In LinQuadOptInterface.jl the MOI `AbstractOptimizer` is specialized to `LinQuadOptimizer`. In this implementation all the above mentioned modifications are carried out by the low-level solver's own functionalities and hence the `LinQuadOptimizer` can be used without a `CachingOptimizer`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.


Can we get links to CachingOptimizer etc?

s/julia/Julia

odow · 2018-03-10T21:11:51Z

README.md

+
+In LinQuadOptInterface.jl the MOI `AbstractOptimizer` is specialized to `LinQuadOptimizer`. In this implementation all the above mentioned modifications are carried out by the low-level solver's own functionalities and hence the `LinQuadOptimizer` can be used without a `CachingOptimizer`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.
+
+Here the data in the julia level is minimal, basically only references to constraints and variables.


Instead of this sentence maybe something along the lines of "In contrast, since LinQuadOptimizer incrementally pushes data to the low-level solver, it stores a small subset of the problem data at the Julia level; typically only references to constraints and variables."

odow · 2018-03-10T21:13:33Z

README.md

+
+This package is currently used to implement [MathOptInterfaceXpress.jl](https://github.com/JuliaOpt/MathOptInterfaceXpress.jl), [MathOptInterfaceCPLEX.jl](https://github.com/JuliaOpt/MathOptInterfaceCPLEX.jl), [MathOptInterfaceGurobi.jl](https://github.com/JuliaOpt/MathOptInterfaceGurobi.jl) and [MathOptInterfaceGLPK.jl](https://github.com/JuliaOpt/MathOptInterfaceGLPK.jl). The last one being only a integer linear solver.
+
+All these solvers have low-level APIs which supports most of these modifications. Hence, data storage is simplified and duplications are avoided.


What are "these modifications"?

joaquimg · 2018-03-10T23:03:27Z

Is the CachingOptimizer in MOI manual?

odow · 2018-03-10T23:25:45Z

README.md

+
+This package is currently used to implement [MathOptInterfaceXpress.jl](https://github.com/JuliaOpt/MathOptInterfaceXpress.jl), [MathOptInterfaceCPLEX.jl](https://github.com/JuliaOpt/MathOptInterfaceCPLEX.jl), [MathOptInterfaceGurobi.jl](https://github.com/JuliaOpt/MathOptInterfaceGurobi.jl) and [MathOptInterfaceGLPK.jl](https://github.com/JuliaOpt/MathOptInterfaceGLPK.jl). The last one being only a integer linear solver.
+
+All these solvers have low-level APIs which supports most of the above metioned [modifications](#modifications). Hence, data storage is simplified and duplications are avoided.


s/supports/support
s/metioned/mentioned

odow · 2018-03-10T23:26:47Z

README.md

+
+## Current uses
+
+This package is currently used to implement [MathOptInterfaceXpress.jl](https://github.com/JuliaOpt/MathOptInterfaceXpress.jl), [MathOptInterfaceCPLEX.jl](https://github.com/JuliaOpt/MathOptInterfaceCPLEX.jl), [MathOptInterfaceGurobi.jl](https://github.com/JuliaOpt/MathOptInterfaceGurobi.jl) and [MathOptInterfaceGLPK.jl](https://github.com/JuliaOpt/MathOptInterfaceGLPK.jl). The last one being only a integer linear solver.


s/a integer/an integer or s/a integer/a mixed integer

joaquimg · 2018-03-11T17:04:15Z

I am merging this because people will start looking. Open for suggestions and PRs :)

readme first sketch

2ddf536

blegat reviewed Dec 7, 2017

View reviewed changes

Update README.md

57e8709

mlubin reviewed Dec 9, 2017

View reviewed changes

Update README.md

6635790

joaquimg modified the milestone: 11kim Dec 15, 2017

mlubin reviewed Dec 20, 2017

View reviewed changes

joaquimg added 2 commits March 10, 2018 01:20

Merge remote-tracking branch 'origin/master' into jg/readme

bd6ca68

# Conflicts: # README.md

update readme

210d347

improve name

1fb52ea

blegat reviewed Mar 10, 2018

View reviewed changes

joaquimg added 3 commits March 10, 2018 10:53

fixes

c407096

Add links, fix typo, add disclaimer

CachingOptimizer

1d84e4f

Remove ambiguous sentence

645f9e2

mlubin reviewed Mar 10, 2018

View reviewed changes

joaquimg added 2 commits March 10, 2018 15:08

add suggestions

754fdc7

replace instance by optimizer

2177186

odow reviewed Mar 10, 2018

View reviewed changes

add suggestions

3a5a42d

joaquimg added 3 commits March 10, 2018 20:04

try html self ref

ad51801

separate mods

17f5ac2

add some

03b1ccf

joaquimg added 2 commits March 10, 2018 20:25

missing link

e82075a

missing brace

b0765d8

odow reviewed Mar 10, 2018

View reviewed changes

joaquimg added 2 commits March 10, 2018 20:27

supports

c948f35

fix english

30f2fc2

mlubin approved these changes Mar 11, 2018

View reviewed changes

joaquimg merged commit afe07e7 into master Mar 11, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

readme first sketch #2

readme first sketch #2

joaquimg commented Dec 7, 2017

blegat Dec 7, 2017

blegat Dec 7, 2017

mlubin Dec 9, 2017

mlubin Dec 9, 2017

mlubin Dec 20, 2017

joaquimg Dec 20, 2017

mlubin Dec 20, 2017

joaquimg Dec 20, 2017

mlubin Dec 20, 2017

joaquimg Dec 28, 2017

mlubin commented Mar 9, 2018

joaquimg commented Mar 10, 2018

joaquimg commented Mar 10, 2018

blegat Mar 10, 2018

blegat Mar 10, 2018

joaquimg Mar 10, 2018

blegat Mar 10, 2018

blegat Mar 10, 2018

mlubin Mar 10, 2018

mlubin Mar 10, 2018

mlubin Mar 10, 2018

mlubin Mar 10, 2018

odow Mar 10, 2018

odow Mar 10, 2018

odow Mar 10, 2018

odow Mar 10, 2018

joaquimg commented Mar 10, 2018

odow Mar 10, 2018

odow Mar 10, 2018

joaquimg commented Mar 11, 2018


		All these modification are caried out by the low-level solver own functionalities and hence it differs from MathOptInterfaceUtilities' `Instance`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.

		Here the data in the julia level is minimal, basically only references to constraints and varibles.


		## LinQuadOptInterface Instance

		In the MOI `Instance` made available by LinQuadOptInterface.jl all these modification are caried out by the low-level solver own functionalities and hence it differs from MathOptInterfaceUtilities' `Instance`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.


		## LinQuadOptInterface Instance

		In LinQuadOptInterface.jl the MOI `AbstractOptimizer` is specified to `LinQuadOptimizer`. In this implementation all the above metioned modifications are caried out by the low-level solver own functionalities and hence it differs from MathOptInterface.Utilities' `AbstractModel`'s generated by the `@model` macro. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.


		## Current uses

		This package is currently used to implement `MathOptInterfaceXpress.jl`, `MathOptInterfaceCPLEX.jl`, `MathOptInterfaceGurobi.jl` and `MathOptInterfaceGLPK.jl`. The last one being only a integer linear solver.


		Attention: This is an intermediary layer used by some implementations of the MathOptInterface.

		LinQuadOptInterface (LQOI) is designed to make it easier for low-level wrapper designed to bridge low-level Integer Linear and Quadratic solvers to implement the [MathOptInterface](https://github.com/JuliaOpt/MathOptInterface.jl) (MOI) interface. It provides access to many MOI functionalities mainly related to problem modifications:


		## LinQuadOptInterface Optimizer

		In LinQuadOptInterface.jl the MOI `AbstractOptimizer` is specialized to `LinQuadOptimizer`. In this implementation all the above mentioned modifications are carried out by the low-level solver's own functionalities and hence the `LinQuadOptimizer` can be used without a `CachingOptimizer`. The latter will keep all problem data in the julia level and typically push to a low-level solver the complete problem at once.


		This package is currently used to implement [MathOptInterfaceXpress.jl](https://github.com/JuliaOpt/MathOptInterfaceXpress.jl), [MathOptInterfaceCPLEX.jl](https://github.com/JuliaOpt/MathOptInterfaceCPLEX.jl), [MathOptInterfaceGurobi.jl](https://github.com/JuliaOpt/MathOptInterfaceGurobi.jl) and [MathOptInterfaceGLPK.jl](https://github.com/JuliaOpt/MathOptInterfaceGLPK.jl). The last one being only a integer linear solver.

		All these solvers have low-level APIs which supports most of these modifications. Hence, data storage is simplified and duplications are avoided.

readme first sketch #2

readme first sketch #2

Conversation

joaquimg commented Dec 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlubin commented Mar 9, 2018

joaquimg commented Mar 10, 2018

joaquimg commented Mar 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joaquimg commented Mar 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joaquimg commented Mar 11, 2018