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

DOC: Change datatypes of A matrices in linprog #9362

Merged

Kai-Striega merged 4 commits into scipy:master from Kai-Striega:doc_9323

Oct 15, 2018

Member

Kai-Striega commented Oct 7, 2018

closes #9323

Change datatype of A_ub from 1D array to 2D array
Change dataype of A_eq from array_like to 2D array
Add full description of tableau T in simplex method
Shorten descriptions of A_ub, A_eq and A


          DOC: Update linprog documentation

120caab

* Change datatype of ``A_ub`` from ``1D array`` to ``2D array``
* Change dataype of ``A_eq`` from ``array_like`` to ``2D array``
* Add full description of tableau ``T`` in simplex method
* Shorten descriptions of ``A_ub``, ``A_eq`` and ``A``

ilayn reviewed

View reviewed changes

scipy/optimize/_linprog.py Outdated

-D array which, when matrix-multiplied by ``x``, gives the values of
-                      the upper-bound inequality constraints at ``x``.
+                  A_ub : 2D array, optional
+D array such that ``A_ub`` @ ``x`` gives the values of the upper-bound

Member

ilayn Oct 7, 2018

I think @ sign doesn't render well in the docs between two code markups. But it is my subjective view.

Member

ev-br Oct 7, 2018

The whole expression A @ x is code.

Member

ilayn Oct 7, 2018

I meant these ones

Member Author

Kai-Striega Oct 7, 2018

@ilayn I thought the convention is to mark variables as variable_name? Looking at the picture I agree it looks odd. If you think it's worth rewriting I can do it tomorrow.

Member

pv Oct 7, 2018 •

edited

Loading

I guess the relevant guidelines are:
https://numpydoc.readthedocs.io/en/latest/format.html
http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

The double-backtick quotes I think for the most part are used for inline code samples, which A_ub @ x in principle is.
Also note that the tableau table code should probably be put in a multiline literal block.

Member Author

Kai-Striega Oct 7, 2018

From the numpy guidelines:

Enclose variables in single backticks.

So, technically, this should be: A @ x, right? To me A @ x still looks better/readable and worth going back and changing.

Member

ilayn Oct 7, 2018

Yes since you are referring to a math expression rather than the individual variables involved, I guess A @ x would be clearer. But again, just a suggestion, I don't have a strong opinion.

Member

ilayn commented Oct 7, 2018 •

edited

Loading

Since we are at it, the return parameter in

scipy/scipy/optimize/_linprog.py

Line 260 in 120caab

A `scipy.optimize.OptimizeResult` consisting of the following fields:

doesn't have an argument and hence marks the whole sentence as the output type argument. Maybe something like

Returns
--------
opt_res : OptimizeResult
    A :class:`scipy.optimize.OptimizeResult` object with the following fields 
    ....

with a clickable link can be more informative.

Kai-Striega added 2 commits

October 8, 2018 10:36


          Edit A matrix descriptions to inline expression

c63356e


          DOC: Move linprog return value into newline

f31bc73

rgommers added Documentation scipy.optimize labels

Member Author

Kai-Striega commented Oct 14, 2018

@ilayn do you think we can merge this?

ilayn reviewed

View reviewed changes

Member

ilayn left a comment

I see that the _ub variables have A_ub @ x in their docstrings but _eq variables A_eq @ x. Is that a copy/paste slip or they have different meanings? I think I didn't get that point.

But if we are happy with those, it is good to go. Please go ahead and merge. They look good to me.

scipy/optimize/_linprog.py Outdated

-                      the equality constraints at ``x``.
-                  b_eq : array_like, optional
+                  A_eq : 2D, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

+D array such that ``A_ub @ x`` gives the values of the upper-bound
+                      inequality constraints at ``x``.
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

+D array such that ``A_ub @ x`` gives the values of the upper-bound
+                      inequality constraints at ``x``.
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

-                      the equality constraints at ``x``.
-                  b_eq : array_like, optional
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

-                      the equality constraints at ``x``.
-                  b_eq : 1D array
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

-                      the equality constraints at ``x``.
-                  b_eq : array_like
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

-                      the equality constraints at ``x``.
-                  b_eq : array_like, optional
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

-                  b_eq : 1D array
+                      constraint (row) in ``A_ub``.
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

+D array of values representing the upper-bound of each inequality
+                      constraint (row) in ``A_ub``.
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @

scipy/optimize/_linprog_util.py Outdated

+D array of values representing the upper-bound of each inequality
+                      constraint (row) in ``A_ub``.
+                  A_eq : 2D array, optional
+D array such that ``A_eq`` @ ``x`` gives the values of the equality

Member

ilayn Oct 14, 2018

code formatting of @


          DOC: Change A_eq description to inline

7347e03

Member Author

Kai-Striega commented Oct 14, 2018 •

edited

Loading

@ilayn Yes, that was a copy paste slip, I've changed it now and will merge once the tests pass.

ilayn added this to the 1.2.0 milestone

Member

ilayn commented Oct 14, 2018 •

edited

Loading

The Travis failure is not related and is due to #9190 that uses numpy.moveaxis which is newer than our least supported NumPy version 1.8.2. I'll fix that but I don't understand why it didn't fail on that PR.

Member

ilayn commented Oct 14, 2018

I've just restarted the failing case to make sure it wasn't a hiccup of some sort.

Kai-Striega merged commit 8047001 into scipy:master

Kai-Striega deleted the doc_9323 branch

October 15, 2018 05:23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment