teadocs / numpy-cn

NumPy官方中文文档（完整版）

Teadocs

Teadocs is a quick and easy WEB document setup tool.

下一个版本 TODO

• 更新说明文档（中文、英文）💪
• dev 时候产生的目录改名为.temp，并且dev断开后自动删除该文件夹。💪
• 自动递增端口 by dkvirus #25 👍
• tree.md 功能优化 by dkvirus #24 👍
• 增加单元测试/页面测试 😘
• 函数/类增加完整注释说明 😘

Documentation

• 中文: http://docs.teadocs.cn/cn
• english: http://docs.teadocs.cn/en

Getting Started

installation

Prerequisites: Nodejs(>=8.0), npm version 3+.

$ npm install -g teadocs

usage

step 1

Initialize a new document project

$ teadcos init mydocs

step 2

Go to this folder

$ cd mydocs

step 3

This step is to enter the document editing mode, this mode will monitor the markdown file changes in real-time hot replacement of html pages.

$ teadocs dev

Automatically generate md

If you want to be lazy, you can run this command again. This command will automatically generate the relevant markdown file from tree.html.

$ teadocs init

build docs

Build from ./mydocs

$ teadocs build

LICENSE

MIT License

Copyright (c) 2019 ZhiBing([email protected])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

numpy-cn's Issues

博客主题能否开源

主题很赞，能否开源

参考手册中的随机抽样404

常用API-->随机抽样(numpy.random) : https://www.numpy.org.cn/reference/random/index.html

快速入门教程的“使用索引数组进行索引”代码有误

>>> a = np.arange(12).reshape(3,4)
>>> a
array([[ 0,  1,  2,  3],
       [ 4,  5,  6,  7],
       [ 8,  9, 10, 11]])
>>> i = np.array( [ [0,1],                        # indices for the first dim of a
...                 [1,2] ] )
>>> j = np.array( [ [2,1],                        # indices for the second dim
...                 [3,3] ] )
>>>
>>> a[i,j]                                     # i and j must have equal shape
array([[ 2,  5],
       [ 7, 11]])
>>>
>>> a[i,2]
array([[ 2,  6],
       [ 6, 10]])
>>>
>>> a[:,j]                                     # i.e., a[ : , j]
array([[[ 2,  1],
        [ 3,  3]],
       [[ 6,  5],
        [ 7,  7]],
       [[10,  9],
        [11, 11]]])

当然，我们可以按顺序（比如列表）放入i，j然后使用列表进行索引。

>>> l = [i,j]
>>> a[l]                                       # equivalent to a[i,j]
array([[ 2,  5],
       [ 7, 11]])

经测试，最后一行代码会出错

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
IndexError: index 3 is out of bounds for axis 0 with size 3

与后面“数组的数组”作索引的错误相同
python3.10.6 numpy1.23.4

文档目录“NumPy参考文章/进阶篇/NumPy数据分析练习/ ”中发现1个笔误

目录：NumPy参考文章/进阶篇/NumPy数据分析练习/
中“64. 如何从二维数组中减去一维数组，其中一维数组的每一项从各自的行中减去？”

问题描述部分
现为：b_1d = np.array([1,1,1]
应为：b_1d = np.array([1,2,3])

基础篇 Numpy 的安装并不太准确

在基础篇 NumPy 的安装这一则内容中的表述并不太准确，如下：
基础篇 NumPy 的安装

对于 Windows 用户而言，直接在 cmd 或者 power shell 中输入 pip install numpy 命令后，安装的并不是完整版的 NumPy.
没有 mkl 支持的 NumPy 没法生成窗函数（至少是这个，别的函数应该也有不支持的）。

建议 Windows 用户从 Unofficial Windows Binaries for Python Extension Packages 网站下载对应的 .whl 文件，然后再用 pip install 命令安装对应的 numpy-[version-bit].whl. #

vuepress-theme-teadocs版本不匹配

使用npm install初始化项目的时候有如下报错：

npm ERR! code ETARGET
npm ERR! notarget No matching version found for vuepress-theme-teadocs@^2.0.0-beta.53.
npm ERR! notarget In most cases you or one of your dependencies are requesting
npm ERR! notarget a package version that doesn't exist.

npm ERR! A complete log of this run can be found in: D:\nodejs\node_cache\_logs\2023-07-30T02_37_18_411Z-debug-0.log

我是Windows系统，node版本v19.7.0，npm版本9.8.1。

站内很多图片都挂了

项目中大部分图片都挂了，比如随便翻开一页：https://www.numpy.org.cn/deep/basics/fit_a_line.html#%E6%95%88%E6%9E%9C%E5%B1%95%E7%A4%BA

里面的图片1就没有显示，图片位置：https://github.com/PaddlePaddle/book/blob/develop/01.fit_a_line/image/predictions.png?raw=true

建议图片还是放在本github比较好。

ps ，本项目github首页https://github.com/teadocs/numpy-cn的logo图片都挂了。

“快速入门”章节中Numpy文档的跳转问题

在“快速入门”章节中，所有Numpy方法的文档链接跳转有问题，点击后，URL前面增加了多余的内容，从而导致跳转失败。

翻译有问题

这个翻译太不严谨了，类似的地方还有多处

Latex

/docs/benchmarking/README.md中的一处笔误

第一句用 ​​irspeed Velocity 对 NumPy 进行基准测试中irspeed应为airspeed
这部分内容和numpy official website上的相比似乎还没有完成（或者本来就不打算完全翻译？）

如何实现网址的可视化

请问网址的页面也是可以通过github实现的吗，有教程推荐吗

错别字 --->>> 胡

它胡打印我们创建的数组的形状：(5,)。这表明my_array是一个包含5个元素的数组。 错别字 --->>> 胡
https://www.numpy.org.cn/article/basics/understanding_numpy.html

请问有离线版的吗

在线版打开太慢，希望有离线版的

NumPy基础知识有一笔误

具体网址：https://www.numpy.org.cn/user/basics/io.html
此处BytesIO()参数为byte类型，而data是字符串，应该改为StringIO()。

页面下拉的时候，最上面一栏也跟着往下走

代码错误

https://www.numpy.org.cn/article/basics/numpy_matrices_vectors.html

截图所示少个右括号 ')'

输入与输出章节：TypeError: a bytes-like object is required, not 'str'

在章节https://github.com/teadocs/numpy-cn/blob/master/docs/user/basics/io.md中，运行一下代码data = "1, 2, 3, 4, 5, 6" np.genfromtxt(BytesIO(data), delimiter=",")出现TypeError: a bytes-like object is required, not 'str'错误
我得环境是python3.7.
此处的代码应该改为np.genfromtxt(BytesIO(data.encode()), delimiter=",")就可以正常运行

更新numpy v1.23.3

关注到numpy翻译已经有两年多没有更新了， 希望可以参与更新。

@lisniuse

不翻译函数的具体页面嘛？

里面有一些示例。

站内链接 404 Not Found

https://www.numpy.org.cn/user_guide/numpy_for_matlab_users.html

Not Found
The requested URL /numpy-cn/user_guide/numpy_for_matlab_users.html was not found on this server.

在次之前的都打不开。