Numpy: np.conj vs. np.conjugate

Erstellt am 29. Mai 2017  ·  4Kommentare  ·  Quelle: numpy/numpy

Sowohl numpy.conj als auch numpy.conjugate existieren, und tatsächlich zeigen die Dokumente für conj Beispiele, die conjugate :

https://docs.scipy.org/doc/numpy-1.12.0/reference/generated/numpy.conj.html

Außerdem existiert die Seite für numpy.conjugate nicht. Es wäre schön, dies konsistenter zu machen, z. B. die Beispiele für die Seite conj zu ändern, um conjugate , oder eine Notiz zu den conj Dokumenten hinzuzufügen, die beides sein kann Gebraucht.

04 - Documentation

Hilfreichster Kommentar

Wo wir gerade dabei sind, ist es wahrscheinlich gut, darauf hinzuweisen, dass es sich tatsächlich nur um Aliase handelt:

In [2]: np.conj is np.conjugate
Out[2]: True

Alle 4 Kommentare

Wo wir gerade dabei sind, ist es wahrscheinlich gut, darauf hinzuweisen, dass es sich tatsächlich nur um Aliase handelt:

In [2]: np.conj is np.conjugate
Out[2]: True

Siehe auch np.max und np.amax , wobei wir meiner Meinung nach ersteres fördern sollten

Hallo. Ich möchte das aufgreifen und wollte einen Workflow vorschlagen.
Wir können auch eine separate Seite für np.conjugate erstellen und relevante Beispiele in diese Seite aufnehmen. Ändern Sie außerdem die Beispiele auf der Seite np.conj so, dass sie conj verwenden, und erwähnen Sie auf beiden Seiten, dass es sich um Aliasnamen handelt, und geben Sie im Abschnitt See Also eine Referenz an.
Dies dient dazu, die Konsistenz mit der Dokumentation von Aliasnamen aufrechtzuerhalten, wie dies beispielsweise bei der Funktion np.random.random der Fall ist. Bitte lassen Sie mich wissen, ob ich mit diesem Ablauf fortfahren kann. Danke!

@kritisingh1 - da die beiden Funktionen gleich sind - np.conj is np.conjugate - müssen Sie nur den einen Dokumentstring aktualisieren, den sie gemeinsam haben. Ich denke, ich würde überall np.conjugate verwenden, da es im Allgemeinen gut ist, keine Abkürzungen zu verwenden (und conj wird explizit als Alias ​​in ufuncmodule.c erstellt). Auch das erfordert zufällig die geringste Änderung: Der Docstring könnte einfach erwähnen, dass np.conj ein Alias ​​ist. Um Ihnen das Suchen zu ersparen: Die Docstrings sind in numpy/core/code_generators/ufunc_docstrings.py

Dann besteht der nächste Schritt darin sicherzustellen, dass Dokumentationsseiten für beide Funktionen generiert werden. Hier müssen Sie sowohl docs/source/reference/routines.umath.src als auch docs/source/reference/ufuncs.rst anpassen.

Wenn Sie gerade dabei sind, wäre es möglich, auch den Docstring von remainder zu aktualisieren, um zu erwähnen, dass mod ein Alias ​​ist? Außerdem bin ich mir nicht ganz sicher, ob die Liste in ufuncs.rst tatsächlich aktuell ist. Es könnte gut sein, mit dem zu vergleichen, was wir tatsächlich ausstellen:

import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
War diese Seite hilfreich?
0 / 5 - 0 Bewertungen