Numpy: np.conj vs np.conjugate

Criado em 29 mai. 2017  ·  4Comentários  ·  Fonte: numpy/numpy

Ambos numpy.conj e numpy.conjugate existem e, de fato, os documentos para conj mostram exemplos que usam conjugate :

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

Além disso, a página para numpy.conjugate não existe. Seria bom tornar isso mais consistente, por exemplo, alterar os exemplos para a página conj para usar conjugate , ou adicionar uma nota aos documentos conj que podem ser usava.

04 - Documentation

Comentários muito úteis

Enquanto estamos nisso, provavelmente é bom garantir que notemos que eles são, de fato, apenas aliases:

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

Todos 4 comentários

Enquanto estamos nisso, provavelmente é bom garantir que notemos que eles são, de fato, apenas aliases:

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

Veja também np.max e np.amax , para os quais eu sinto que devemos encorajar o primeiro

Oi. Eu gostaria de levar isso em consideração e queria propor um fluxo de trabalho.
Também podemos criar uma página separada para np.conjugate e incluir exemplos relevantes nessa página. Além disso, altere os exemplos na página np.conj para usar conj e mencione em ambas as páginas que eles são aliases um do outro e forneça referência na seção See Also .
Isso é para manter a consistência com a documentação de aliases, como é feito com, por exemplo, a função np.random.random Por favor, deixe-me saber se eu posso prosseguir com este fluxo. Obrigado!

@kritisingh1 - já que as duas funções são as mesmas -- np.conj is np.conjugate -- você só precisa atualizar a docstring que elas compartilham. Acho que usaria np.conjugate todos os lugares, já que geralmente é bom não usar abreviações (e conj é criado explicitamente como um alias em ufuncmodule.c ). Além disso, isso precisa da menor alteração: a docstring poderia apenas mencionar que np.conj é um alias. Para economizar na pesquisa: as docstrings estão em numpy/core/code_generators/ufunc_docstrings.py

Em seguida, a próxima etapa é garantir que as páginas de documentação para ambas as funções sejam geradas. Aqui, você tem que ajustar docs/source/reference/routines.umath.src e docs/source/reference/ufuncs.rst .

Enquanto você está nisso, seria possível também atualizar a docstring de remainder para mencionar que mod é um alias? Além disso, não tenho certeza se a lista em ufuncs.rst está de fato atualizada. Pode ser bom comparar com o que realmente expomos:

import numpy
ufuncs = [key for key in dir(numpy) if isinstance(getattr(numpy, key), numpy.ufunc)]
Esta página foi útil?
0 / 5 - 0 avaliações

Questões relacionadas

thouis picture thouis  ·  4Comentários

perezpaya picture perezpaya  ·  4Comentários

manuels picture manuels  ·  3Comentários

navytux picture navytux  ·  4Comentários

'
Pezhvuk picture Pezhvuk  ·  4Comentários