Numpy: np.conjとnp.conjugate

作成日 2017年05月29日  ·  4コメント  ·  ソース: numpy/numpy

numpy.conjnumpy.conjugateの両方が存在し、実際、 conjのドキュメントには、 conjugateを使用する例が示されています。

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

さらに、numpy.conjugateのページは存在しません。 これをより一貫性のあるものにするとよいでしょう。たとえば、 conjページの例をconjugateを使用するように変更するか、 conjドキュメントにメモを追加します。使用済み。

04 - Documentation

最も参考になるコメント

私たちがそれに取り組んでいる間、それらが実際には単なるエイリアスであることに注意するのはおそらく良いことです:

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

全てのコメント4件

私たちがそれに取り組んでいる間、それらが実際には単なるエイリアスであることに注意するのはおそらく良いことです:

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

np.maxnp.amaxも参照してください。前者を奨励する必要があると思います。

こんにちは。 これを取り上げて、ワークフローを提案したいと思います。
np.conjugate用に別のページを作成し、そのページに関連する例を含めることもできます。 また、 np.conjページの例を変更してconjを使用し、両方のページでそれらが相互のエイリアスであることを示し、 See Alsoセクションで参照を提供します。
これは、たとえばnp.random.random関数で行われるように、エイリアスのドキュメントとの一貫性を維持するためです。このフローを続行できるかどうかをお知らせください。 ありがとう!

@ kritisingh1-2つの関数は同じであるため- np.conj is np.conjugate -共有する1つのdocstringを更新するだけで済みます。 略語を使用しないのが一般的に良いので、どこでもnp.conjugateを使用すると思います(そしてconjufuncmodule.cのエイリアスとして明示的に作成されます)。 また、それはたまたま最小限の変更で済みます。docstringは、 np.conjがエイリアスであるとだけ言及することができます。 検索を節約するために:docstringsはnumpy/core/code_generators/ufunc_docstrings.pyにあります

次に、次のステップは、両方の機能のドキュメントページが生成されるようにすることです。 ここでは、 docs/source/reference/routines.umath.srcdocs/source/reference/ufuncs.rstの両方を調整する必要があります。

その間、 remainderのdocstringを更新して、 modがエイリアスであることを示すこともできますか? また、 ufuncs.rstのリストが実際に最新であるかどうかはよくわかりません。 私たちが実際に公開しているものと比較するのは良いかもしれません:

import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
このページは役に立ちましたか?
0 / 5 - 0 評価

関連する問題

inducer picture inducer  ·  3コメント

Levstyle picture Levstyle  ·  3コメント

Kreol64 picture Kreol64  ·  3コメント

navytux picture navytux  ·  4コメント

toddrjen picture toddrjen  ·  4コメント