summaryrefslogtreecommitdiff
path: root/doc/neps
Commit message (Collapse)AuthorAgeFilesLines
* NEP: Update NEP 42 and 43 according to the current implementationSebastian Berg2020-12-072-30/+53
| | | | | | | | | | | | | | | | | | | We modified the `resolve_descriptors` function to not use `context` which is a bit heavy weight, and that also allows removing of DTypes from the context. This means it now passes `self, DTypes` (where self is the unbound ArrayMethod). Also add a note on the -1 return value of `resolve_descriptors`. Apply suggestions from code review Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> Fixup note on CastingImpl being mainly a NEP 42 name Fixup sphinx warnings
* MAINT: Rewrite can-cast logic in terms of NEP 42Sebastian Berg2020-11-241-2/+2
|
* Merge pull request #17725 from pentschev/nep-35-downstream-like-instructionsSebastian Berg2020-11-161-15/+102
|\ | | | | NEP: Add NEP-35 instructions on reading like= downstream
| * NEP: NEP-35 phrasing fixPeter Andreas Entschev2020-11-131-1/+1
| | | | | | Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net>
| * NEP: Small NEP-35 wording fixPeter Andreas Entschev2020-11-061-3/+3
| |
| * NEP: Add NEP-35 instructions on reading like= downstreamPeter Andreas Entschev2020-11-061-12/+99
| |
* | NEP36: include additional feedback (#17578)Stefan van der Walt2020-11-011-9/+13
|/ | | | | | Include some last feedback from Ralf and Ben Co-authored-by: Ralf Gommers <ralf.gommers@gmail.com>
* NEP: Ensure inner loop signature is complete everywhereSebastian Berg2020-10-271-18/+20
| | | | | | This makes sure the signature is complete everywhere and for now renames `userdata` to `innerloop_data`, which may be less confusing with regards to the previous (but different) userdata.
* DOC: Don't use Python highlighting for non-python codeEric Wieser2020-10-259-48/+98
|
* NEP 36 (fair play) (#14779)Stefan van der Walt2020-10-171-0/+173
|
* DOC: Include NEP titles for first reference in NEP 42Ben Nathanson2020-10-141-3/+3
| | | | | Rather than saying 'NEP 4x', the links in the note at the top now include the NEP titles as well.
* DOC: MAINT: Add NEP 43 links to NEP 42Ben Nathanson2020-10-141-8/+8
|
* NEP: Initial draft for NEP 43 for extensible ufuncs (gh-16723)Sebastian Berg2020-10-133-0/+5614
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * NEP: Initial draft for NEP 43 * NEP: Small updates to NEP 43 * Partial iteration on some content, mostly updates the calling convention Its not quite settled, I don't quite like the `npy_intp *` as a default "user-data" yet, but I think I may warm up to it, and I think some kind of default like that is really very convenient. Split out `user_data *`, since I think Marten has a point that separating "constant" and volatile data is conceptionally easier. * Add a bit more overview-intro at the start and refactor "bound" method section * Small fixups based on Marten and also Hameers comments * Revise the "promotion and dispatching" section a bit. * Fix back-compat section and add a tiny bit of implementation * WIP: Further updates nep 43 * Revise NEP 43 and expand on arraymethod (previously the dispatching/promotion was more fleshed out) * Update image and make sure it is included at the right place. * small fixups * Update doc/neps/nep-0043-extensible-ufuncs.rst Co-authored-by: Dave Hirschfeld <dave.hirschfeld@gmail.com> * Fix comment which was missing the final part of sentence * Pass through, up to "steps involved in a ufunc call" * Review up to ArrayMethod * Review up to ArrayMethod Specs * Review up to loop reuse * Review most of the remaining document * Fix title typo * Wording updates and minor fixups. * Apply suggestions from code review Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> * Address Ross's additional comments Co-authored-by: Dave Hirschfeld <dave.hirschfeld@gmail.com> Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* DOC: New round of NEP 42 edits (gh-17493)Ben Nathanson2020-10-071-425/+439
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * DOC: Revise NEP 42 "common DType" section * DOC: Eliminate duplicate doc in NEP42 * DOC: Fix missing 'not' in NEP42 edit * DOC: Minor typos in NEP42 edit * DOC: Reword opening sentence of NEP 42 revision Also clarify a wording. * DOC: Correct :class: reference in NEP42 edit * DOC: Fix Windows line-enders on NEP42 edit * DOC: New round of common DType edits of NEP 42 * DOC: Uniquify anchors in NEP 42 * DOC: Typo in NEP42 edit * DOC: Last push for NEP 42 edit * Small fixups and moving example One paragraph on `__common_dtype` in the alternatives was already before very confusing. This makes it hopefully more clear. * NEP: Change title to "New and extensible DTypes" Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net>
* NEP: update NEP 42 with discussion of type hinting applications (#17447)Josh Wilson2020-10-061-12/+39
| | | | | | | | | | | | * NEP: update NEP 42 with discussion of type hinting applications As discussed in https://github.com/numpy/numpy/pull/16759, the new DType classes provide a good path forward for making `ndarray` generic over DType. Update NEP 42 to discuss those applications in more detail. * NEP: discuss typing for use scalar types in NEP 42 Also clean up the language a bit.
* nep-0029 typo correctionSafouane Chergui2020-10-021-1/+1
| | | to provides -> to provide
* NEP: Edit nep-0042 for more clarity (#17370)Sebastian Berg2020-09-275-992/+2705
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * DOC: Edit NEP-42 for clarity * DOC: Further edits of NEP 42 * DOC: Edit NEP-42 for clarity * DOC: Further edits of NEP 42 * WIP: Work out structure a bit and make intro longer * DOC: Round 3 of NEP 42 edits * Start with a new motivation/overview to be forced upon the rest * restructure along "top-level" categories and rename adjust_descriptors * Small fixups * Small clarity/correctness edits * Use `PyArrayMethod` instead of UFuncImpl I am starting to feel that calling this "array method" (even if it is in no way numpy array specific) is probably the best name. It is not ufunc specific, because ufuncs are dispatching + array method. Calling it ufuncimpl makes sense, but since the UFunc name which would also work perfectly is already taken, maybe a whole new name is better. * DOC: Fold in @seberg revisions * Fix typo * Make first example/overview inherit dtype instead of metaclass it could say `metaclass=DTypeMeta`, but its implicit. * DOC: Add "checklist" to NEP 42 Also anchor NEP 40 figure for reference in NEP 42. * Delete duplicated dtype-discovery section The section must have been duplicated in an merge conflict :/, I scanned through, and I think the version that was in the right place got most edits, although not 100% sure. * DOC: Reorganize scope, standardize heds * DOC: Retitle, revisions up to Casting Also anchor for parametric type discussion in NEP 40 * Some smaller changes/additions * DOC: Reorganize for better flow Also adds a NEP anchor at top. * DOC: Glossary, shuffle "Additional information" bullets * DOC: Small updates for sense and case * Fixup merge (some changes were not saved when finishing merge) * Answer bjnath's questions and motivate user impact It seems most answers bjnath already included himself, this adds a few tweaks. Added a note that tusers will basically have to implement the DType class as outlined is basically what the user will have to implement, so spell that out both at the top and in the C-API to clarify that. * NEP 41: Add subsection on dtype organization with parameters This might go a bit far, but I think the image goes very far in giving people the right idea of how to think of dtypes and DType instances. The question is if we want to even show the "alternative"... * Add bjnath as author * Add new header also to NEP 41 * DOC: Minor: delete horiz rules, tweak 2 headings * Rephrase NEP 41 bullt points in terms of NEP 42 Also changes those for NEP 43, to represent what is done, rather than what is solved (and thus fit better to the way its written for the NEP 42 part) * Try to rewerd paragraphs around setitem/getitem a bit some of these were very confusing, hopefully they are a bit better now. * Make a pass over the array-coercion part * Make careful pass up until array-coercion * Pass over the second half of the NEP 42 draft. * Use "given_descrs" which seems clearer and fix casting I always thought returning the casting safety is an awesome idea, but right now I am actually not so sure it helps much with anything. Its usually simpler, I guess. But if the user requested safe casting and we have an unsafe cast, for example for structured dtypes we will end up doing a lot of work for no reason. If we accept an error return without an error already set this is solved. My original reason was that setting a generic error in the resolve descriptor function would really be pretty annoying, so that returning the casting safety seemed like a good way to avoid worrying about most errors there. The "cast-is-view" output is important though. * Fix copy new intro note to NEP 40 (and fix it in NEP 41) Co-authored-by: Ben Nathanson <github@bigriver.xyz>
* NEP: Regenerate table in NEP 29 (add numpy 1.18 and 1.19 to list) (#17337)Matthias Bussonnier2020-09-171-7/+17
| | | | | | | | | | * Regenerate Table for NEP 29. Numpy 1.18 and 1.19 have been released, which add two new recommended stop date for recommended numpy support in 2021 and 2022. * Infer next version as max-known-minor-version+1 Do not print the first 4 entries to be dropped; as they are pre-nep-29
* Merge pull request #17093 from pentschev/nep-35-template-rewriteCharles Harris2020-09-071-73/+234
|\ | | | | NEP: Adjust NEP-35 to make it more user-accessible
| * ENH: Clarifies meta_from_array function in NEP-35Peter Andreas Entschev2020-08-191-6/+26
| |
| * NEP: Fix some grammar and formatting in NEP-35Peter Andreas Entschev2020-08-191-2/+2
| |
| * NEP: Improve grammar on NEP-35 reference to Dask's objectsPeter Andreas Entschev2020-08-191-4/+4
| |
| * NEP: Clarify Dask intent with `my_dask_pad` function namePeter Andreas Entschev2020-08-191-5/+8
| |
| * NEP: Clarify NEP-35 C implementation details.Peter Andreas Entschev2020-08-191-3/+5
| |
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-3/+3
| | | | | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
| * NEP: Move NumPy users comment to top of NEP-35 Usage and ImpactPeter Andreas Entschev2020-08-191-7/+6
| |
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-3/+2
| | | | | | Co-authored-by: Matti Picus <matti.picus@gmail.com>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Matti Picus <matti.picus@gmail.com>
| * NEP: Improve NEP-35 abstract per @mattip's suggestionPeter Andreas Entschev2020-08-191-5/+4
| |
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Chunlin <fangchunlin@huawei.com>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Chunlin <fangchunlin@huawei.com>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Juan Nunez-Iglesias <juan.nunez-iglesias@monash.edu>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Juan Nunez-Iglesias <juan.nunez-iglesias@monash.edu>
| * Update doc/neps/nep-0035-array-creation-dispatch-with-array-function.rstPeter Andreas Entschev2020-08-191-1/+1
| | | | | | Co-authored-by: Juan Nunez-Iglesias <juan.nunez-iglesias@monash.edu>
| * NEP: Simplify NEP-35 further with reviewer's suggestionsPeter Andreas Entschev2020-08-171-17/+39
| |
| * NEP: Adjust NEP-35 to make it more user-accessiblePeter Andreas Entschev2020-08-171-73/+190
| |
* | Merge pull request #17074 from mattip/pydata-sphinx-themeRalf Gommers2020-08-312-63/+40
|\ \ | | | | | | DOC: use the pydata_sphinx_theme
| * | DOC, NEP: move wishlist link to the theme configuationmattip2020-08-142-64/+20
| | |
| * | DOC, NEP: use new theme in NEPs toomattip2020-08-141-0/+21
| |/
* | DOC: NEP-42: Fix a few typos.Warren Weckesser2020-08-221-4/+4
| |
* | DOC: make spacing consistent in NEP 41 bullet pointsJosh Wilson2020-08-201-26/+26
|/ | | | | | | Currently the uneven spacing is making some of the bullet points show up as quoted; see e.g. https://numpy.org/neps/nep-0041-improved-dtype-support.html#backward-compatibility
* NEP: Updated NEP-35 with keyword-only instruction (#17009)Peter Andreas Entschev2020-08-071-6/+13
| | | | | | | | | | | * NEP: Updated NEP-35 with keyword-only instruction Following reviewer's suggestions during the implementation phase, the `like=` argument is now keyword-only, updating the proposal accordingly. * NEP: Changed date of NEP-35 latest update * NEP: Adjust keyword-only marker position in NEP-35
* BUG, MAINT: Remove overzealous automatic RST linkMatthias Bussonnier2020-07-111-2/+0
| | | | | When adding links to all the NEPs, one non-rst file was taken in the crossfire.
* NEP: Update NEP 42 to note the issue of circular references (gh-16778)Sebastian Berg2020-07-081-17/+31
| | | | | | | | | | | * NEP: Update NEP 42 to note the issue of circular references This notes the issue a bit clearer and points out a possible contribution, also list Marten as co-author, since he gave a large chunk of input and discussion. * Apply suggestions from code review Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* NEP 42: Technical decisions for new DTypes (#15507)Sebastian Berg2020-06-113-0/+4477
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This NEP may require some thought and technical changes. There are also a few other things as to how we exactly implement e.g. lookup of which cast to use. I currently envision that we accept NEP 41, with the decision to start on this NEP. However, we keep most of the proposal here private API, and thus somewhat flexible to changes before we finalize the API. Some changes (i.e. the exact "methods", we need to define) should probably not be included here, but rather incrementally added later. Maybe by modifying the document, or adding a new NEP depending on the size of the change. * NEP: Technical decisions for new DTypes * Add datetime to the dtype hierarchy plot * Some clarifications and smaller updates (not a proofread and not examples yet) * clarify how casting will be signalled * Updates to the NEP, hopefully answer a lot of Martens questions Also uses datetime64 as an example in a few places, which is hopefully useful. * Apply suggestions from code review Commit mainly grammer/style fixes from ross (direct suggestions) Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> * Incorporate second chunk of Ross' feedback * Apply suggestions from code review Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> * Minor adjustment, add example for how promote_types works... * Apply suggestions from code review Apply suggestions from Joris. Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> * Incorporate feedback from Marten and Joris Mainly adds a figure for the casting section, and tries to rephrase the first part of it almost entirely around that figure, which should also simplify it a lot, although at this time possible loses a tiny bit precision/details. * NEP: Apply suggestions from Ross <Many fixups from Ross> * NEP: Fix the last section and missing link. Also clarify the ``kind`` and ``char`` a bit, suggesting to use ``__qualname__``. While this is weird for ``char``, it is at least guaranteed to be be unique and to fail when used inapproprioatly. * NEP: Type edits for NEP 42 and Eric Wiesers suggestions Some type edits for the first part mainly and fixups based on Eric's review. * Fixup links Co-Authored-By: Marten van Kerkwijk <mhvk@astro.utoronto.ca> Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* Merge pull request #16445 from rgommers/roadmap-updateCharles Harris2020-06-081-41/+60
|\ | | | | DOC: update roadmap
View Lorry Controller Status