/scikit-learn-doc-cn

scikit-learn机器学习库中文文档翻译项目

Primary LanguageHTML

scikit-learn-doc-cn

Build Status Build Status Build Status

sklearn库作为目前机器学习非常流行的python库,一个易读的文档更有助于工具库的理解和使用,虽然做机器学习方面的学生和工程师阅读英文并没有很大压力,但是在阅读速度上还是会有些影响。 寻找已久没找到相关的中文文档,而且翻译的过程也是对知识熟悉的过程,您可以在学习某一个章节的过程顺便翻译一下就可以贡献自己的力量。

欢迎大家踊跃加入!如果有更好的翻译组织形式也欢迎提出!

加入微信群

sklearn_wechat

*中文文档地址:sklearn.lzjqsdd.com

翻译计划

图标 状态
Build Status 翻译中
Build Status 翻译结束
Build Status 暂未开始

第一阶段

相关算法示例程序的翻译,位于modules下,具体列表如下:

文件 翻译状态 贡献者
linear_model.rst Build Status lzjqsdd
biclustering.rst Build Status alingse
calibration.rst Build Status woshikangfei
classes.rst Build Status woshikangfei
clustering.rst Build Status huangbinapple
computational_performance.rst Build Status iphyer
covariance.rst Build Status RobinSeaside
cross_decomposition.rst Build Status muyeby
cross_validation.rst Build Status LianYun
decomposition.rst Build Status heyuanhao
density.rst Build Status RobinSeaside
dp-derivation.rst Build Status
ensemble.rst Build Status ustblzj
feature_extraction.rst Build Status minoriwww
feature_selection.rst Build Status taoyizhi68
gaussian_process.rst Build Status alingse
grid_search.rst Build Status LianYun
isotonic.rst Build Status LinXueyuanStdio
kernel_approximation.rst Build Status heyuanhao
kernel_ridge.rst Build Status nevertiree
label_propagation.rst Build Status lihao1992
lda_qda.rst Build Status ShangruZhong
learning_curve.rst Build Status taoyizhi68
manifold.rst Build Status nevertiree
metrics.rst Build Status frankchen0130
mixture.rst Build Status haisheng-zhang
model_evaluation.rst Build Status ShangruZhong
model_persistence.rst Build Status iphyer
multiclass.rst Build Status iphyer
naive_bayes.rst Build Status minoriwww
neighbors.rst Build Status zhongyu211
neural_networks_supervised.rst Build Status RobinSeaside
neural_networks_unsupervised.rst Build Status RobinSeaside
outlier_detection.rst Build Status iphyer
pipeline.rst Build Status bwanglzu
preprocessing.rst Build Status Perfe
preprocessing_targets.rst Build Status Perfe
random_projection.rst Build Status iphyer
scaling_strategies.rst Build Status iphyer
sgd.rst Build Status lzjqsdd
tree.rst Build Status RobinSeaside
unsupervised_reduction.rst Build Status iphyer
svm.rst Build Status lzjqsdd
decomposition.rst Build Status Stephen.Z

首先fork该项目到个人github,clone到本地,修改README中要申领的翻译内容的状态,提交pull request,接受之后即可开始翻译工作。 翻译结束后确保可正常编译成html,然后只提交rst文件的修改,不要添加sphinx生成的文件。 所有翻译后的文档以同名的方式添加到translate/同目录文件夹下,例如:

svm.rst的翻译文档 提交到项目translate/modules/svm.rst下,翻译完成之后覆盖doc/modules/svm.rst。

建议翻译时参考wiki中的术语对照表 推荐文本编辑器:vscode+Preview插件 或 vim ,可以对rst文件语法高亮,避免翻译过程中出现语法错误

阶段二

官方框架翻译

配置及编译

自动部署

本项目采用travis-ci持续集成来实现自动编译部署,翻译的文档提交pull request到master,合并后会自动把html部署到gh-pages分支上,网站托管在sklearn.lzjqsdd.com

本地编译

安装必要的环境:

sudo pip install numpy
sudo pip install scipy
sudo pip install sphinx
#上述为依赖的包
sudo pip install -U scikit-learn

生成html(和官网web页一样)

make html

生成文件会在在_build/html目录下:

如果要生成PDF手册的话:

make latexpdf

部署gh-pages:

由于Sphinx生成的html有自己的静态资源,需要在gh-pages分支加入.nojekyll文件。

配置中其他的问题: Issue