主页在 https://zh.gluon.ai/。
请使用 https://discuss.gluon.ai 讨论或报告问题。
所有notebook是用markdown格式存储,这样方便merge改动。jupyter可以通过notedown来直接使用markdown,参考这里安装
build服务器在 https://ci.mxnet.io 。这台服务器有两块Nvidia M60。
可以使用 https://zh.gluon.ai.s3-website-us-west-2.amazonaws.com/ 来访问没有加载过 CDN 的版本,对代码的改动刷新更快。
所有markdown文件需要在提交前清除output,它们会在服务器上重新执行生成结果。所以需要保证每个notebook执行不要太久,目前限制是20min。
在本地可以如下build html(需要GPU支持)
conda env update -f build/build.yml
source activate gluon_zh_docs
make html
生成的html会在_build/html
。
如果没有改动notebook里面源代码,所以不想执行notebook,可以使用
make html EVAL=0
但这样生成的html将不含有输出结果。
编译pdf版本需要xelatex、librsvg2-bin(svg图片转pdf)和思源字体。在Ubuntu可以这样安装。
sudo apt-get install texlive-full
sudo apt-get install librsvg2-bin
wget https://github.com/adobe-fonts/source-han-sans/raw/release/OTF/SourceHanSansSC.zip
wget https://github.com/adobe-fonts/source-han-serif/raw/release/OTF/SourceHanSerifSC_SB-H.zip
wget https://github.com/adobe-fonts/source-han-serif/raw/release/OTF/SourceHanSerifSC_EL-M.zip
unzip SourceHanSansSC.zip
unzip SourceHanSerifSC_EL-M.zip
unzip SourceHanSerifSC_SB-H.zip
sudo mv SourceHanSansSC SourceHanSerifSC_EL-M SourceHanSerifSC_SB-H /usr/share/fonts/opentype/
sudo fc-cache -f -v
这时候可以通过 fc-list :lang=zh
来查看安装的中文字体。
同样的去下载和安装英文字体
wget -O source-serif-pro.zip https://www.fontsquirrel.com/fonts/download/source-serif-pro
unzip source-serif-pro -d source-serif-pro
sudo mv source-serif-pro /usr/share/fonts/opentype/
wget -O source-sans-pro.zip https://www.fontsquirrel.com/fonts/download/source-sans-pro
unzip source-sans-pro -d source-sans-pro
sudo mv source-sans-pro /usr/share/fonts/opentype/
wget -O source-code-pro.zip https://www.fontsquirrel.com/fonts/download/source-code-pro
unzip source-code-pro -d source-code-pro
sudo mv source-code-pro /usr/share/fonts/opentype/
sudo fc-cache -f -v
然后就可以编译了。
make pdf
python -m spacy download en # 需已 pip install spacy
贡献请遵照本教程的样式规范。
翻译请参照中英文术语对照。