summaryrefslogtreecommitdiff
path: root/doc/source/reference
Commit message (Collapse)AuthorAgeFilesLines
* DOC: Add SIMD optimization documentation (gh-15551)Matti Picus2020-07-126-0/+774
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add documentation for the new build infrastructure and API developed to enable universal intrinsics. Written by @seiko2plus with some fixes by @mattip. * DOC: add SIMD optimization doc (seiko2plus) * DOC: reformat as valid RST * trim whitespace * first part of Understanding CPU Dispatching * update build options and remove implied features, gonna update it later * add more explanations for the dispatcher and fix doc style * fix up style * add figure * Improve and more explanations for Understanding CPU Dispatching * fix up syntax * DOC: tweak formatting * DOC: more tweaks * fix rst formatting * DOC: Generate CPU features tables from CCompilerOpt * DOC: move files around * DOC: add comment to top of file * DOC: rebuild tables, fix links * DOC: minor copyedits Co-authored-by: Sayed Adel <seiko@imavr.com> Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* Update doc/source/reference/arrays.nditer.rst dpitch402020-07-081-1/+3
| | | | | Improve wording Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* DOC: fix rST note directive formatting.Ross Barnowski2020-07-071-1/+3
|
* Added note at the top of the reference section on iteration linking to the ↵David Pitchford2020-07-071-0/+4
| | | | quickstart documentation section on basic iteration
* Merge pull request #16738 from Qiyu8/fix_typoMatti Picus2020-07-031-1/+1
|\ | | | | DOC: Remove redundant word
| * remove redundant wordQiyu82020-07-031-1/+1
| |
* | DOC: reword random c-api introduction, cython is documented in Extending ↵Matti Picus2020-07-021-13/+7
| | | | | | | | | | (#16731) DOC: reword random c-api introduction, cython is documented in Extending
* | DOC: Add lib.format.open_memmap to autosummary.Ross Barnowski2020-06-221-1/+1
|/ | | | | Fixes link in See also section of np.memmap docs and ensures open_memmap is included in the summary of io functions.
* Merge pull request #13516 from seiko2plus/core_improve_infa_buildMatti Picus2020-06-171-0/+1
|\ | | | | ENH: enable multi-platform SIMD compiler optimizations
| * ENH: [1/7] enable multi-platform SIMD compiler optimizationsSayed Adel2020-06-151-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Implement new distutils class `CCompilerOpt`, used for handling the CPU/hardware optimization, starting from parsing the command arguments, to managing the relationship between the CPU baseline and dispatch-able features, also generating the required C headers and ending with compiling the sources with proper compiler's flags. `CCompilerOpt` mainly used as a helper class for `CCompiler`, and doesn't provide any runtime detection for the CPU features, instead only focuses on the compiler side, but it generates abstract C headers that can be used later for the final runtime dispatching process.
* | DOC: add documentation for the numpy.typing moduleJosh Wilson2020-06-102-0/+3
|/
* DOC: Fixes for 18 broken links (#16472)bjnath2020-06-064-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * DOC: Fixes for 18 broken links This, with PR #16465, should fix nearly all the remaining broken links on the site. 4 or 5 others should be easy to fix and just need attention from someone more knowledgeable -- will open an issue. For release notes with dead links, I could usually find links on archive.org for roughly contemporary versions. * DOC: Update to "Fixes for 18 broken links #16472" * Obsolete links, previously commented out, now deleted: https://github.com/numpy/numpy/pull/16472#discussion_r433928958 * Semantic markup for reference to Python class: https://github.com/numpy/numpy/pull/16472#discussion_r433553928 * Missing :ref: in internal link: https://github.com/numpy/numpy/pull/16472#discussion_r433554484 Not included: Resolution on using external/internal doc link in .py: https://github.com/numpy/numpy/pull/16472#discussion_r433554824 * DOC: Add internal link for 'Fixes for 18 broken links' PR #16472 Making reference [1] an internal link in function_base.py => numpy.vectorize.html * DOC: Redirect 2 link fixes in PR #16472 * governance.rst link reverted * ununcs.rst `overridden` link goes where it was meant to per https://github.com/numpy/numpy/pull/16472#pullrequestreview-424666070
* Merge pull request #15666 from rossbar/enh/poly_strMatti Picus2020-06-042-3/+26
|\ | | | | ENH: Improved `__str__` for polynomials
| * DOC: Update poly class refguide printing.Ross Barnowski2020-05-152-3/+26
| | | | | | | | | | | | | | | | | | Update routines.polynomials.classes doc in the refguide to reflect changes to polynomial printing. Add additional information to the document about the various ways that the string representation of polynomial expressions can be controlled via formatting.
* | DOC: Fix spelling typo - homogenous to homogeneous. (#16324)Kevin Moore2020-05-212-2/+2
| |
* | DOC: Correct documentation of ``__array__`` when used as output array. (#16130)Tina Oberoi2020-05-211-3/+2
| |
* | Merge pull request #16156 from WarrenWeckesser/deprecate-dualSebastian Berg2020-05-191-1/+1
|\ \ | | | | | | DEP: Deprecate `numpy.dual`.
| * | DOC: dual: Note the deprecation of numpy.dual in the dual module docstring.Warren Weckesser2020-05-051-1/+1
| | | | | | | | | | | | Also make the correction "Scipy" -> "SciPy" in a few places.
* | | DOC: Add PyArray_ContiguousFromObject C docs (gh-16207)Guilherme Leobas2020-05-181-3/+11
| | | | | | | | | | | | | | | | | | Add documentation for `PyArray_ContiguousFromObject` similar to the other macros wrapping `PyArray_FromAny` Fixes #16196
* | | DOC: Fix typos and cosmetic issuesMartin Michlmayr2020-05-174-5/+5
| | |
* | | DOC: Unify cross-references between array joining methodsTim Hoffmann2020-05-102-8/+8
| | |
* | | Merge pull request #16078 from rossbar/doc/axis_to_new_or_differentMatti Picus2020-05-072-0/+15
|\ \ \ | |/ / |/| | DOC: Add axis to random module "new or different" docs
| * | DOC: Added `permutation` to methods with axis kwarg.Ross Barnowski2020-04-252-6/+7
| | | | | | | | | | | | | | | Added `permutation` to `choice` and `shuffle` in the list of highlighted methods with an `axis` kwarg.
| * | DOC: Added bullet about axis kwarg to rng overview docs.Ross Barnowski2020-04-252-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | Modified the introductory/overview documentation for the random module to highlight the addition of the `axis` kwarg to methods like `shuffle` and `choice` for dealing with multi-dimensional arrays. Related to gh-16075
* | | Merge pull request #15769 from seberg/hugepages-allow-togglingMatti Picus2020-05-032-0/+86
|\ \ \ | | | | | | | | ENH: Allow toggling madvise hugepage and fix default
| * | | Further DOC-Fixup base don Ross' reviewSebastian Berg2020-03-181-16/+16
| | | |
| * | | Apply suggestions from code review by RossSebastian Berg2020-03-171-10/+10
| | | | | | | | | | | | Co-Authored-By: Ross Barnowski <rossbar@berkeley.edu>
| * | | DOC: Note few global global options we currently have in refdocsSebastian Berg2020-03-172-0/+86
| | |/ | |/| | | | | | | | | | These are options that are controlled typically through environment variable at startup or compile time.
* | | DOC: Added page describing how to contribute to the docs team (#16069)Melissa Weber Mendonça2020-05-031-1/+1
| | |
* | | DOC: Moved timeit examples under relevant bullet point.Ross Barnowski2020-04-251-11/+12
| | |
* | | DOC,BLD: Limit timeit iterations in random docs.Ross Barnowski2020-04-251-6/+6
| |/ |/| | | | | | | | | | | | | | | | | Limiting the number of loops performed in the %timeit evaluation results in a ~20% speedup in the time it takes to build the documentation. The results of the "benchmarking" are less accurate from the limited number of evaluations, but the relationship between the timing between the legacy and Generator sampling methods is preserved.
* | DOC: Add missing bracket (gh-16051)Chunlin2020-04-251-1/+1
| | | | | | Add missing closing brackets, script to generate the list in the PR gh-16051.
* | DOC: Clarify single-segment arrays in np reference (#16011)Anirudh Subramanian2020-04-221-0/+5
| | | | | | | | | | * Update doc/source/reference/arrays.ndarray.rst Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* | DOC: Update documentation w.r.t. NPY_RELAXED_STRIDES_CHECKING (gh-15907)Sebastian Berg2020-04-101-4/+6
| | | | | | | | This has been the default for a very long time, so this was incorrect and mentioning any versions is probably not helpful.
* | Merge pull request #15749 from panpiort8/masked_array_docsMatti Picus2020-04-041-1/+1
|\ \ | | | | | | DOC: document inconsistency between the shape of data and mask in numpy.ma
| * | Update doc/source/reference/maskedarray.baseclass.rstMatti Picus2020-04-041-1/+1
| | | | | | | | | Co-Authored-By: Sebastian Berg <sebastian@sipsolutions.net>
| * | DOC: document inconsistent mask results in MaskedArrayPan Jan2020-03-261-1/+1
| | | | | | | | | | | | Co-Authored-By: Tianxiang “Ronnie” Gao <tienhsiangkao@tamu.edu>
* | | DOC: Add missing doc of numpy.ma.apply_over_axes in API list.Qiyu82020-04-021-0/+1
| | |
* | | Merge pull request #15843 from melissawm/new-docs-indexCharles Harris2020-03-271-1/+1
|\ \ \ | | | | | | | | DOC: First steps towards docs restructuring (NEP 44)
| * | | DOC: First steps towards docs restructuring (NEP 44)Melissa Weber Mendonca2020-03-261-1/+1
| | | |
* | | | DOC: fix typo in C-API referenceGabriel Gerlero2020-03-271-1/+1
| | | |
* | | | DOC: fix remaining doc files for refguide_check (#15720)Pierre de Buyl2020-03-262-159/+169
| | | | | | | | | | | | | | | | | | | | * DOC: skip f2py fortran and arrays.nditer cython tests for refguide_check * DOC: fix formatting of doc tests and improper use of nditer
* | | | MAINT: simplify code that assumes str/unicode and int/long are different ↵Eric Wieser2020-03-262-2/+1
|/ / / | | | | | | | | | | | | types (#15816) Cleanup from the dropping of python 2
* | | DOC: correct possible list lengths for `extobj` in ufunc callsJosh Wilson2020-03-221-5/+5
| |/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | According to the docs, the list can be of lengths 1, 2, or 3, but only length 3 appears to work: ``` >>> import numpy as np >>> np.sin(1, extobj=[16, 1, lambda: None]) 0.8414709848078965 >>> np.sin(1, extobj=[16, 1]) Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: UFUNC_PYVALS must be a length 3 list. >>> np.sin(1, extobj=[16]) Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: UFUNC_PYVALS must be a length 3 list. ```
* | BUG: add missing c_distributions.pxd, enables cython use of random C-API ↵Matti Picus2020-03-161-2/+11
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | (gh-15463) xref gh-14778 As pointed out in the comment by @jamesthomasgriffin, we did not include a pxd file to expose the distribution functions documented in the random c-api. This PR adds a c_distributions.pxd file that exposes them. Squashed commits: * BUG: add missing c_distributions.pxd to enable cython use of random C-API * ENH, TST: add npyrandom library like npymath, test cython use of it * BUG: actually prefix f-string with f * MAINT: fixes from review, add _bit_generato_bit_generator.pxd * STY: fixes from review * BLD: don't use nprandom library for mtrand legacy build * TST: WindowsPath cannot be used in subprocess's list2cmdline * MAINT, API: move _bit_generator to bit_generator * DOC: add release note about moving bit_generator * DOC, MAINT: fixes from review * MAINT: redo dtype determination from review
* DOC: Refactor `np.polynomial` docs using `automodule` (#15662)Ross Barnowski2020-03-128-555/+43
| | | * DOC: Refactor polynomial docs using automodule.
* 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
| |
View Lorry Controller Status