summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #15745 from WarrenWeckesser/remove-doc-summarizeRalf Gommers2020-03-121-178/+0
|\ | | | | MAINT: doc: Remove doc/summarize.py
| * MAINT: doc: Remove doc/summarize.pyWarren Weckesser2020-03-111-178/+0
| | | | | | | | | | | | | | The code in doc/summarize.py is no longer used and it is not being maintained, so remove it. Closes gh-15708.
* | DOC: Refactor `np.polynomial` docs using `automodule` (#15662)Ross Barnowski2020-03-128-555/+43
|/ | | * DOC: Refactor polynomial docs using automodule.
* NEP 41: First steps towards improved Datatype Support (gh-15506)Sebastian Berg2020-03-112-0/+4370
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This NEP is supposed to: 1. Motivate the whole DType change and lay out a rough plan. 2. Clarify a few mainly high level decision/plans. 3. Get inertia on starting to implement espeically a DTypeMeta class in C, and slowly add new private API working towards Phase II, which is planned t be better specified by NEP 42 and 43. Full list of squashed commits (including suggestions below): * NEP: Create NEP41, proposing a rough plan for new DTypes * Try to clarify how datatypes are "natural" compared to array likes and clean up API breakage section * Fix references (mostly at least) * Add a first draft of a few examples. * Reorganize examples as per suggestion by Marten and add ufunc loop note * Make a pass on the first chunk and number the later stuff to match * Some minaor adjustments * Add, probably silly, picture. * Add pngs, since it is probably easier to render... * Small changes, mainly to see if I can make it render... * Apply suggestions from code review Thanks @crusaderky especially for type reading and all the reference, etc. issues! Co-Authored-By: crusaderky <crusaderky@gmail.com> Co-Authored-By: Maximilian Roos <5635139+max-sixty@users.noreply.github.com> * Tiny fixes, mainly fix title levels hopefully It seems I am not allowd to skip a title level in one point but not another. * Small changes/fixups * Reorganize sections to better fit template. * Further swapping of Detailed Information part. * Make motivation clear and mention user impact section the user impact section is more useful than the actual motivation section.... since the motivation is more technical in nature * Small editing of the first few sections * Some further small type-edits for the later sections * Add a small paragraph mentioning the intention of a fallback * Smaller changes, rework phases at beginning of scopes section * Mention which NEP is to define which bullet point in Phase II * Consolidate point 1+2 into a single point and clarify the incompatible change * Mention the change of how methods are defined in the backcompat section * Add a note at the top of the NEP (will need to be links to other NEPs) This note will almost identiclaly be added to the other NEPs then.. * Fixups mainly based on comments from Ross (large chunks are directly using his suggestions) * Apply suggestions from code review Co-Authored-By: Eric Wieser <wieser.eric@gmail.com> * Incorporate most of Erics comments (which were not already suggestions) * Update doc/neps/nep-0041-improved-dtype-support.rst Co-Authored-By: Eric Wieser <wieser.eric@gmail.com> * Apply suggestions from code review Co-Authored-By: Eric Wieser <wieser.eric@gmail.com> * Small reformatting, fix authors and add drafty acknowledgments Ross does not want authorship, so he has to suffer through this ;). Co-authored-by: crusaderky <crusaderky@gmail.com> Co-authored-by: Maximilian Roos <5635139+max-sixty@users.noreply.github.com> Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* ENH: Add `subok` parameter to np.copy function (cf. gfh6509) (gh-15685)Ross Barnowski2020-03-111-0/+9
| | | | | This is largely a re-submission of the original change proposed in #6509. Discussion was hosted in multiple forums including #3474, the numpy mailing list circa 10-2015, and the 02-26-2020 NumPy Triage meeting. This PR closes #3474 and #15570
* DOC: Change license date 2019 -> 2020 (gh-15735)Himanshu Garg2020-03-101-1/+1
| | | Update Year 2019 -> 2020
* DOC: Allow NEPs to link to python, numpy, scipy, and matplotlib docsSebastian Berg2020-03-091-1/+15
| | | | | This was originally added by Matti for use in NEP 41, but splitting it off, since it is generally useful
* Merge pull request #15702 from mwtoews/optparseCharles Harris2020-03-082-25/+15
|\ | | | | MAINT: Replace optparse with argparse for 'doc' and 'tools' scripts
| * MAINT: replace optparse with argparse for 'doc' and 'tools' scriptsMike Taves2020-03-092-25/+15
| |
* | DOC: Fix coremath.rst to fix refguide_check (#15718)Pierre de Buyl2020-03-061-1/+6
| | | | | | | | | | * DOC: fix coremath.rst to fix refguide_check Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* | Merge pull request #15717 from pdebuyl/fix_refguide_datetimeMatti Picus2020-03-061-51/+25
|\ \ | | | | | | DOC: update datetime reference to pass refguide
| * | Update doc/source/reference/arrays.datetime.rstPierre de Buyl2020-03-061-2/+1
| | | | | | | | | Co-Authored-By: Eric Wieser <wieser.eric@gmail.com>
| * | DOC: move deprecation info to apart paragraph.Pierre de Buyl2020-03-061-4/+8
| | |
| * | reinstate example with offsetPierre de Buyl2020-03-061-0/+2
| | |
| * | DOC: remove outdated example and sectionPierre de Buyl2020-03-061-51/+20
| | | | | | | | | | | | | | | | | | Remove example with timezone Remove section on changes in NumPy 1.11
* | | Merge pull request #15534 from seberg/deprecate-abstract-scalar-typesMatti Picus2020-03-062-2/+25
|\ \ \ | | | | | | | | DEP: Do not allow "abstract" dtype conversion/creation
| * | | Fixup: Do not deprecate generic python typesSebastian Berg2020-02-071-2/+14
| | | | | | | | | | | | | | | | | | | | Add a comment that we can think about only allowing it for `dtype=...` though...
| * | | DEP: Do not allow "abstract" dtype conversion/creationSebastian Berg2020-02-061-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These dtypes do not really make sense as instances. We can (somewhat) reasonably define np.dtype(np.int64) as the default (machine endianess) int64. (Arguably, it is unclear that `np.array(arr_of_>f8, dtype="f")` should return arr_of_<f8, but that would be very noisy!) However, `np.integer` as equivalent to long, is not well defined. Similarly, `dtype=Decimal` may be neat to spell `dtype=object` when you intend to put Decimal objects into the array. But it is misleading, since there is no special meaning to it at this time. The biggest issue with it, is that `arr.astype(np.floating)` looks like it will let float32 or float128 pass, but it will force a float64 output! Arguably downcasting is a bug in this case. A related issue is `np.dtype("S")` and especially "S0". The dtype "S" does make sense for most or all places where `dtype=...` can be passed. However, it is conceptionally different from other dtypes, since it will not end up being attached to the array (unlike "S2" which would be). The dtype "S" really means the type number/DType class of String, and not a specific dtype instance.
* | | | DOC: Change list to tuple in example description. (gh-15705)Sebastian Berg2020-03-051-2/+2
| |/ / |/| | | | | | | | | | | | | | | | | | | | | | | Changed a description in the quickstart example to use tuple instead of the deprecated list for indexing arrays. The change is located at the Indexing with Arrays of Indices section. Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: Matti Picus <matti.picus@gmail.com> Closes gh-15699
* | | DOC: fix SVD tutorial to pass refguide (#15710)Matti Picus2020-03-051-1/+6
| | | | | | | | | | | | | | | * DOC: fix printing and add traceback for SVD tutorial Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* | | DOC: Fix quickstart doc to pass refguide (#15703)Matti Picus2020-03-051-38/+54
| | | | | | | | | | | | | | | * DOC: Fix quickstart doc to pass refguide Fix printing of arrays. Co-Authored-By: Eric Wieser <wieser.eric@gmail.com>
* | | NEP: move NEP 44 to accepted status (#15683)Melissa Weber Mendonça2020-03-041-1/+5
| | | | | | | | | | | | | | | | | | * Added Discussion link to the mailing list thread. * Changing NEP0044 status to Accepted.
* | | Merge pull request #15701 from sandy-lcq/masterCharles Harris2020-03-044-4/+4
|\ \ \ | | | | | | | | MAINT: Convert shebang from python to python3 (#15687)
| * | | convert shebang from python to python3 (#15687)Changqing Li2020-03-044-4/+4
| | |/ | |/| | | | | | | Signed-off-by: Changqing Li <changqing.li@windriver.com>
* | | DOC: Fix indexing docs to pass refguide (#15694)Pierre de Buyl2020-03-041-21/+12
|/ / | | | | | | * DOC: Add missing imports, np prefix, fix printing, fix examples Co-Authored-By: Eric Wieser <wieser.eric@gmail.com>
* | DOC: Add missing imports, definitions and dummy file (#15616)Pierre de Buyl2020-03-031-2/+7
| | | | | | | | | | * DOC: fix imports and defs to pass refguide checks Add empty file foo.c at runtime to run distutils config.
* | DOC: Make extension module wording more clearmatt2020-02-291-8/+8
| |
* | Merge pull request #15295 from melissawm/linalg-tutorialMatti Picus2020-02-289-1/+596
|\ \ | | | | | | DOC: Added tutorial about linear algebra on multidimensional arrays
| * | Fixing linksmelissawm2020-02-281-10/+11
| | |
| * | Fixing formatting of source.melissawm2020-02-271-46/+72
| | |
| * | Added intersphinx mappings for skimage and imageio; added proper links to ↵melissawm2020-02-272-21/+10
| | | | | | | | | | | | external docs.
| * | Fixed missing backtick.melissawm2020-02-211-1/+1
| | |
| * | Added plot scripts and reworded to respond to PR comments.melissawm2020-02-217-74/+212
| | |
| * | Incorporated @bonn0062's suggestions.Melissa Weber Mendonça2020-01-241-15/+16
| | |
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>
| * | Update doc/source/user/tutorial-svd.rstMelissa Weber Mendonça2020-01-241-1/+1
| | | | | | | | | Co-Authored-By: Anne Bonner <35413198+bonn0062@users.noreply.github.com>