DOC: add NumPy import in scipy.optimize examples #16832

ak04p · 2022-08-12T06:14:19Z

Reference issue

What does this implement/fix?

Added import numpy as np to docstring examples for scipy.optimize

Additional information

AtsushiSakai · 2022-08-13T11:58:14Z

scipy/io/matlab/_mio.py

@@ -274,6 +274,7 @@ def savemat(file_name, mdict,
    Examples
    --------
    >>> from scipy.io import savemat
+    >>> import numpy as np


Should this line be at the top of the code block based on this comment?
I think other code changes should obey the rule also.

I'll make the necessary changes then.

I've made changes to scipy.optimize . However, changes to scipy.io have already been merged. So should I change it or leave it as is?

I realized that this change is not for the "optimize" module now. If the main branch already has this change, could you please rebase this PR branch on the main branch? Or if not, could you please remove changes in the io module from this PR? I think this PR only focuses on changes for the optimize module.

Thank you for the feedback, I've removed changes in the io module from this PR.

I've made the changes according to your review.

AtsushiSakai · 2022-08-14T05:28:01Z

scipy/optimize/_lsq/least_squares.py

@@ -638,6 +639,7 @@ def least_squares(
    estimate it by finite differences and provide the sparsity structure of
    Jacobian to significantly speed up this process.

+    >>> import numpy as np


I think this import statement is not needed because of the rule: "Add them a maximum of once per "Example" section."

I'll take note of this.

AtsushiSakai · 2022-08-14T05:29:54Z

scipy/optimize/_lsq/least_squares.py

@@ -744,6 +746,7 @@ def least_squares(
    We wrap it into a function of real variables that returns real residuals
    by simply handling the real and imaginary parts as independent variables:

+    >>> import numpy as np


I think this import statement is not needed because of the rule: "Add them a maximum of once per "Example" section."

AtsushiSakai · 2022-08-14T05:30:56Z

scipy/optimize/_minpack_py.py

@@ -711,6 +712,7 @@ def curve_fit(f, xdata, ydata, p0=None, sigma=None, absolute_sigma=False,

    Examples
    --------
+    >>> import numpy as np


Suggested change

>>> import numpy as np

>>> import numpy as np

>>> import matplotlib.pyplot as plt

AtsushiSakai · 2022-08-14T05:33:38Z

scipy/optimize/_optimize.py

@@ -1015,6 +1020,7 @@ def check_grad(func, grad, x0, *args, epsilon=_epsilon,
    ...     return x[0]**2 - 0.5 * x[1]**3
    >>> def grad(x):
    ...     return [2 * x[0], -1.5 * x[1]**2]
+    >>> import numpy as np


This should move to the top of the Example section.

I'll fix this now.

AtsushiSakai · 2022-08-14T05:35:02Z

scipy/optimize/_optimize.py

@@ -2742,6 +2750,7 @@ def bracket(func, xa=0.0, xb=1.0, args=(), grow_limit=110.0, maxiter=1000):
    This function can find a downward convex region of a function:

    >>> import matplotlib.pyplot as plt
+    >>> import numpy as np


"import numpy as np" should be first than "import matplotlib.pyplot as plt".

I'll take note of this.

AtsushiSakai · 2022-08-14T05:36:16Z

scipy/optimize/_root.py

@@ -136,6 +136,7 @@ def root(fun, x0, args=(), method='hybr', jac=None, tol=None, callback=None,
    ...     return [x[0]  + 0.5 * (x[0] - x[1])**3 - 1.0,
    ...             0.5 * (x[1] - x[0])**3 + x[1]]

+    >>> import numpy as np


This should be at the top of the Example section.

AtsushiSakai · 2022-08-14T05:36:48Z

scipy/optimize/_root.py

@@ -163,6 +164,7 @@ def root(fun, x0, args=(), method='hybr', jac=None, tol=None, callback=None,

    The solution can be found using the ``method='krylov'`` solver:

+    >>> import numpy as np


This should be the top of the example section.

I was thinking since this was a separate example, I should add import numpy as np. I'll remove it since it has already been added to the top of the examples section.

AtsushiSakai · 2022-08-14T05:37:23Z

scipy/optimize/_zeros_py.py

@@ -210,6 +210,7 @@ class of similar problems can be solved together.

    Examples
    --------
+    >>> import numpy as np
    >>> from scipy import optimize
    >>> import matplotlib.pyplot as plt


This plt import should be next to the np import

tupui · 2022-08-16T09:19:11Z

LGTM now thank you @ak04p and @AtsushiSakai for the review.

ak04p requested a review from andyfaff as a code owner August 12, 2022 06:14

AtsushiSakai added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.optimize labels Aug 13, 2022

AtsushiSakai reviewed Aug 13, 2022

View reviewed changes

AtsushiSakai reviewed Aug 14, 2022

View reviewed changes

ak04p added 2 commits August 14, 2022 11:37

Added 'import numpy as np' to examples in scipy.optimize

ee32190

Moved import numpy as np to top of code block

c2d2640

ak04p force-pushed the optimize-doc branch from 1db6963 to c2d2640 Compare August 14, 2022 06:08

Fixed imports

86dceb2

tupui approved these changes Aug 16, 2022

View reviewed changes

tupui added this to the 1.10.0 milestone Aug 16, 2022

tupui merged commit b3277e0 into scipy:main Aug 16, 2022

	>>> import numpy as np
	>>> import numpy as np
	>>> import matplotlib.pyplot as plt

		@@ -163,6 +164,7 @@ def root(fun, x0, args=(), method='hybr', jac=None, tol=None, callback=None,

		The solution can be found using the ``method='krylov'`` solver:

		>>> import numpy as np

Uh oh!

DOC: add NumPy import in scipy.optimize examples #16832

DOC: add NumPy import in scipy.optimize examples #16832

Uh oh!

Conversation

ak04p commented Aug 12, 2022

Reference issue

What does this implement/fix?

Additional information

Uh oh!

AtsushiSakai Aug 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AtsushiSakai Aug 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AtsushiSakai Aug 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tupui commented Aug 16, 2022

Uh oh!

Uh oh!

AtsushiSakai Aug 13, 2022 •

edited

Loading

AtsushiSakai Aug 14, 2022 •

edited

Loading

AtsushiSakai Aug 14, 2022 •

edited

Loading