Apache V2 License header added to all readme files
Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/24d11899 Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/24d11899 Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/24d11899 Branch: refs/heads/master Commit: 24d11899c43f162d0e88cb1d7be2067bd24a7f20 Parents: 381d318 Author: aviral <[email protected]> Authored: Tue Jun 26 21:00:15 2018 +0530 Committer: aviral <[email protected]> Committed: Tue Jun 26 21:00:15 2018 +0530 ---------------------------------------------------------------------- doc/README.md | 18 ++++++++++++++ doc/en/docs/notebook/README.md | 18 ++++++++++++++ doc/zh/docs/model_zoo/char-rnn/README.md | 21 ++++++++++++++-- doc/zh/docs/model_zoo/cifar10/README.md | 18 ++++++++++++++ .../docs/model_zoo/imagenet/alexnet/README.md | 18 ++++++++++++++ .../docs/model_zoo/imagenet/densenet/README.md | 22 +++++++++++++++-- .../docs/model_zoo/imagenet/googlenet/README.md | 20 ++++++++++++++- .../docs/model_zoo/imagenet/inception/README.md | 20 ++++++++++++++- doc/zh/docs/model_zoo/imagenet/resnet/README.md | 22 +++++++++++++++-- doc/zh/docs/model_zoo/imagenet/vgg/README.md | 24 +++++++++++++++--- doc/zh/docs/model_zoo/mnist/README.md | 20 +++++++++++++-- examples/caffe/README.md | 18 ++++++++++++++ examples/char-rnn/README.md | 19 +++++++++++++- examples/cifar10/README.md | 20 ++++++++++++++- examples/imagenet/alexnet/README.md | 18 ++++++++++++++ examples/imagenet/densenet/README.md | 18 ++++++++++++++ examples/imagenet/googlenet/README.md | 18 ++++++++++++++ examples/imagenet/inception/README.md | 18 ++++++++++++++ examples/imagenet/resnet/README.md | 18 ++++++++++++++ examples/imagenet/vgg/README.md | 18 ++++++++++++++ examples/mnist/README.md | 18 ++++++++++++++ tool/conda/cpu/README.md | 18 ++++++++++++++ tool/conda/gpu/README.md | 18 ++++++++++++++ tool/conda/singa/README.md | 19 +++++++++++++- tool/docker/README.md | 22 ++++++++++++++--- tool/jenkins/README.md | 26 +++++++++++++++++--- 26 files changed, 483 insertions(+), 24 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/README.md ---------------------------------------------------------------------- diff --git a/doc/README.md b/doc/README.md index 3652fa2..6de5072 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # How to Contribute to Documentation http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/en/docs/notebook/README.md ---------------------------------------------------------------------- diff --git a/doc/en/docs/notebook/README.md b/doc/en/docs/notebook/README.md index 14b7333..5a561eb 100644 --- a/doc/en/docs/notebook/README.md +++ b/doc/en/docs/notebook/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> These are some examples in IPython notebooks. You can open them in [notebook viewer](http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/en/docs/notebook/index.ipynb). http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/char-rnn/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/char-rnn/README.md b/doc/zh/docs/model_zoo/char-rnn/README.md index 41d67ce..bcf3c18 100644 --- a/doc/zh/docs/model_zoo/char-rnn/README.md +++ b/doc/zh/docs/model_zoo/char-rnn/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # å¨ææ¬ä¸è®ç»Char-RNN éå½ç¥ç»ç½ç»ï¼RNNï¼è¢«å¹¿æ³ç¨äºå»ºæ¨¡é¡ºåºæ°æ®ï¼ä¾å¦èªç¶è¯è¨å¥åã æ¬ç¤ºä¾ä»ç»å¦ä½ä½¿ç¨SINGAçRNNå±å®ç°RNNåºç¨ç¨åºï¼æ模åï¼ã æ们å°ä½¿ç¨[char-rnn](https://github.com/karpathy/char-rnn)模åä½ä¸ºç¤ºä¾ï¼å®å°è®ç»è¯å¥ææºä»£ç ï¼å¹¶å°æ¯ä¸ªå符ä½ä¸ºè¾å ¥åä½ã ç¹å«æ¯ï¼æ们å°ä½¿ç¨GRUå¨Linuxå æ ¸æºä»£ç ä¸è®ç»ä¸ä¸ªRNNã ç»è¿è®ç»ï¼æ们å¸æä»æ¨¡åä¸çæææä¹ç代ç ã @@ -7,7 +25,7 @@ * ç¼è¯å¹¶å®è£ SINGAãç®åï¼RNNçå®ç°æ¯åºäºCuDNNï¼>=5.05ï¼ã. -* åå¤æ°æ®éãä¸è½½[å æ ¸æºä»£ç ](http://cs.stanford.edu/people/karpathy/char-rnn/)ãå ¶ä»ææ¬æ°æ®ä¹å¯è¢«ä½¿ç¨ã +* åå¤æ°æ®éãä¸è½½[å æ ¸æºä»£ç ](http://cs.stanford.edu/people/karpathy/char-rnn/)ãå ¶ä»ææ¬æ°æ®ä¹å¯è¢«ä½¿ç¨ã * å¼å§è®ç»ï¼ @@ -22,4 +40,3 @@ python sample.py 'model.bin' 100 --seed '#include <std' 请ç¨å ¶ä¸ä¸ä¸ªcheckpointè·¯å¾æ¿æ¢'model.bin'çè·¯å¾ã - http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/cifar10/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/cifar10/README.md b/doc/zh/docs/model_zoo/cifar10/README.md index 5ee68f6..4b27bc1 100644 --- a/doc/zh/docs/model_zoo/cifar10/README.md +++ b/doc/zh/docs/model_zoo/cifar10/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # å¨Cifar-10ä¸è®ç»CNN å·ç§¯ç¥ç»ç½ç»ï¼CNNï¼æ¯ä¸ç§è¢«å¹¿æ³ç¨äºå¾ååè§é¢åç±»çåé¦äººé ç¥ç»ç½ç»ãå¨æ¤ä¾åä¸ï¼æ们å°å¨Cifar-10æ°æ®éä¸è®ç»ä¸ä¸ªæ·±åº¦CNN模åæ¥è¿è¡å¾ååç±»ï¼ http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/imagenet/alexnet/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/imagenet/alexnet/README.md b/doc/zh/docs/model_zoo/imagenet/alexnet/README.md index ab28732..05ea2b3 100644 --- a/doc/zh/docs/model_zoo/imagenet/alexnet/README.md +++ b/doc/zh/docs/model_zoo/imagenet/alexnet/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # å¨ImageNetä¸è®ç»AlexNet å·ç§¯ç¥ç»ç½ç»ï¼CNNï¼æ¯ä¸ç§å¹¿æ³ç¨äºå¾ååè§é¢åç±»çåé¦ç¥ç»ç½ç»ã å¨è¿ä¸ªä¾åä¸ï¼æ们å°ä½¿ç¨[深度CNN模å](http://papers.nips.cc/paper/4824-imagenet-classification-with-deep-convolutional-neural-networks)æ¥å¯¹ImageNetæ°æ®éè¿è¡å¾ååç±»ã http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/imagenet/densenet/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/imagenet/densenet/README.md b/doc/zh/docs/model_zoo/imagenet/densenet/README.md index ed36fa2..cb51274 100644 --- a/doc/zh/docs/model_zoo/imagenet/densenet/README.md +++ b/doc/zh/docs/model_zoo/imagenet/densenet/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> name: DenseNet on ImageNet SINGA version: 1.1.1 SINGA commit: license: https://github.com/pytorch/vision/blob/master/torchvision/models/densenet.py --- @@ -18,7 +36,7 @@ name: DenseNet on ImageNet SINGA version: 1.1.1 SINGA commit: license: https://g * è¿è¡ç¨åº $ python serve.py -h - + * è¿è¡ç¨åº # use cpu @@ -40,4 +58,4 @@ image1.jpg, image2.jpgåimage3.jpgåºè¯¥å¨æ§è¡æ令å就已被ä¸è½½ã * è¿è¡ç¨åº - $ python convert.py -h \ No newline at end of file + $ python convert.py -h http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/imagenet/googlenet/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/imagenet/googlenet/README.md b/doc/zh/docs/model_zoo/imagenet/googlenet/README.md index ec4533c..81cd564 100644 --- a/doc/zh/docs/model_zoo/imagenet/googlenet/README.md +++ b/doc/zh/docs/model_zoo/imagenet/googlenet/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> name: GoogleNet on ImageNet SINGA version: 1.0.1 @@ -41,7 +59,7 @@ image1.jpg, image2.jpgåimage3.jpgåºè¯¥å¨æ§è¡æ令å就已被ä¸è½½ã ## 详ç»ä¿¡æ¯ -æ们é¦å ä»[Caffeçcheckpointæ件](http://dl.caffe.berkeleyvision.org/bvlc_googlenet.caffemodel)ä¸æååæ°å¼ï¼å¹¶è½¬æ¢ä¸ºpickleçæ¬ãä¸è½½checkpointæ件åè¿å ¥`caffe_root/python`æ件夹ï¼è¿è¡å¦ä¸èæ¬ï¼ +æ们é¦å ä»[Caffeçcheckpointæ件](http://dl.caffe.berkeleyvision.org/bvlc_googlenet.caffemodel)ä¸æååæ°å¼ï¼å¹¶è½¬æ¢ä¸ºpickleçæ¬ãä¸è½½checkpointæ件åè¿å ¥`caffe_root/python`æ件夹ï¼è¿è¡å¦ä¸èæ¬ï¼ # to be executed within caffe_root/python folder import caffe http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/imagenet/inception/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/imagenet/inception/README.md b/doc/zh/docs/model_zoo/imagenet/inception/README.md index 3773cd4..d6552c5 100644 --- a/doc/zh/docs/model_zoo/imagenet/inception/README.md +++ b/doc/zh/docs/model_zoo/imagenet/inception/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> name: Inception V4 on ImageNet SINGA version: 1.1.1 SINGA commit: parameter_url: https://s3-ap-southeast-1.amazonaws.com/dlfile/inception_v4.tar.gz parameter_sha1: 5fdd6f5d8af8fd10e7321d9b38bb87ef14e80d56 license: https://github.com/tensorflow/models/tree/master/slim --- @@ -33,4 +51,4 @@ image1.jpg, image2.jpgåimage3.jpgåºè¯¥å¨æ§è¡æ令å就已被ä¸è½½ã æ们é¦å ä»Tensorflowçcheckpointæ件ä¸æååæ°å¼å°ä¸ä¸ªpickleçæ¬ä¸ã ä¸è½½å¹¶è§£å缩checkpointæ件åï¼è¿è¡ä»¥ä¸èæ¬ - $ python convert.py --file_name=inception_v4.ckpt \ No newline at end of file + $ python convert.py --file_name=inception_v4.ckpt http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/imagenet/resnet/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/imagenet/resnet/README.md b/doc/zh/docs/model_zoo/imagenet/resnet/README.md index b790b61..45d2f9d 100644 --- a/doc/zh/docs/model_zoo/imagenet/resnet/README.md +++ b/doc/zh/docs/model_zoo/imagenet/resnet/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> name: Resnets on ImageNet SINGA version: 1.1 SINGA commit: 45ec92d8ffc1fa1385a9307fdf07e21da939ee2f parameter_url: https://s3-ap-southeast-1.amazonaws.com/dlfile/resnet/resnet-18.tar.gz license: Apache V2, https://github.com/facebook/fb.resnet.torch/blob/master/LICENSE --- @@ -18,7 +36,7 @@ name: Resnets on ImageNet SINGA version: 1.1 SINGA commit: 45ec92d8ffc1fa1385a93 * è¿è¡ç¨åº $ python serve.py -h - + * è¿è¡ç¨åº # use cpu @@ -47,4 +65,4 @@ image1.jpg, image2.jpgåimage3.jpgåºè¯¥å¨æ§è¡æ令å就已被ä¸è½½ã * è¿è¡ç¨åº - $ python convert.py -h \ No newline at end of file + $ python convert.py -h http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/imagenet/vgg/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/imagenet/vgg/README.md b/doc/zh/docs/model_zoo/imagenet/vgg/README.md index 083bf8b..36ae471 100644 --- a/doc/zh/docs/model_zoo/imagenet/vgg/README.md +++ b/doc/zh/docs/model_zoo/imagenet/vgg/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> name: VGG on ImageNet SINGA version: 1.1.1 SINGA commit: license: https://github.com/pytorch/vision/blob/master/torchvision/models/vgg.py --- @@ -18,7 +36,7 @@ name: VGG on ImageNet SINGA version: 1.1.1 SINGA commit: license: https://github * è¿è¡ç¨åº $ python serve.py -h - + * ä¾å # use cpu @@ -29,7 +47,7 @@ name: VGG on ImageNet SINGA version: 1.1.1 SINGA commit: license: https://github æ们æä¾äºä»¥ä¸æ¨¡åå深度é ç½®çåæ°æ件: * ä¸ä½¿ç¨æ¹éæ£å, [11](https://s3-ap-southeast-1.amazonaws.com/dlfile/vgg/vgg11.tar.gz), [13](https://s3-ap-southeast-1.amazonaws.com/dlfile/vgg/vgg13.tar.gz), [16](https://s3-ap-southeast-1.amazonaws.com/dlfile/vgg/vgg16.tar.gz), [19](https://s3-ap-southeast-1.amazonaws.com/dlfile/vgg/vgg19.tar.gz) * 使ç¨æ¹éæ£å, [11](https://s3-ap-southeast-1.amazonaws.com/dlfile/vgg/vgg11_bn.tar.gz), [13](https://s3-ap-southeast-1.amazonaws.com/dlfile/vgg/vgg13_bn.tar.gz), [16](https://s3-ap-southeast-1.amazonaws.com/dlfile/vgg/vgg16_bn.tar.gz), [19](https://s3-ap-southeast-1.amazonaws.com/dlfile/vgg/vgg19_bn.tar.gz) - + * æ交å¾çè¿è¡åç±» @@ -45,4 +63,4 @@ image1.jpg, image2.jpgåimage3.jpgåºè¯¥å¨æ§è¡æ令å就已被ä¸è½½ã * è¿è¡ç¨åº - $ python convert.py -h \ No newline at end of file + $ python convert.py -h http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/doc/zh/docs/model_zoo/mnist/README.md ---------------------------------------------------------------------- diff --git a/doc/zh/docs/model_zoo/mnist/README.md b/doc/zh/docs/model_zoo/mnist/README.md index ba8e3f1..8847731 100644 --- a/doc/zh/docs/model_zoo/mnist/README.md +++ b/doc/zh/docs/model_zoo/mnist/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # å¨MNISTæ°æ®éä¸è®ç»RBM模å è¿ä¸ªä¾å使ç¨MNISTæ°æ®éæ¥è®ç»ä¸ä¸ªRBM模åãRBM模ååå ¶è¶ åæ°åè[Hintonç论æ](http://www.cs.toronto.edu/~hinton/science.pdf)ä¸ç设å®ã @@ -14,5 +32,3 @@ é»è®¤æ åµä¸ï¼è®ç»ä»£ç å°å¨CPUä¸è¿è¡ã è¦å¨GPUå¡ä¸è¿è¡å®ï¼è¯·ä½¿ç¨éå åæ°å¯å¨ç¨åºï¼ python train.py mnist.pkl.gz --use_gpu - - http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/caffe/README.md ---------------------------------------------------------------------- diff --git a/examples/caffe/README.md b/examples/caffe/README.md index 92c9325..6ac0fd0 100644 --- a/examples/caffe/README.md +++ b/examples/caffe/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # Use parameters pre-trained from Caffe in SINGA In this example, we use SINGA to load the VGG parameters trained by Caffe to do image classification. http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/char-rnn/README.md ---------------------------------------------------------------------- diff --git a/examples/char-rnn/README.md b/examples/char-rnn/README.md index dcaf652..6a3a9bd 100644 --- a/examples/char-rnn/README.md +++ b/examples/char-rnn/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # Train Char-RNN over plain text Recurrent neural networks (RNN) are widely used for modelling sequential data, @@ -30,4 +48,3 @@ Other plain text files can also be used. python sample.py 'model.bin' 100 --seed '#include <std' Please replace 'model.bin' with the path to one of the checkpoint paths. - http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/cifar10/README.md ---------------------------------------------------------------------- diff --git a/examples/cifar10/README.md b/examples/cifar10/README.md index 65df5e6..7bb63e7 100644 --- a/examples/cifar10/README.md +++ b/examples/cifar10/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # Train CNN over Cifar-10 @@ -41,7 +59,7 @@ version of the Cifar-10 dataset in 'cifar-10-batches-py' folder. python train.py vgg cifar-10-batches-py - To train other models, please replace 'vgg' to 'alexnet', 'resnet' or 'caffe', + To train other models, please replace 'vgg' to 'alexnet', 'resnet' or 'caffe', where 'caffe' refers to the alexnet model converted from Caffe. By default the training would run on a CudaGPU device, to run it on CppCPU, add an additional argument http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/imagenet/alexnet/README.md ---------------------------------------------------------------------- diff --git a/examples/imagenet/alexnet/README.md b/examples/imagenet/alexnet/README.md index be6797c..c3d261e 100644 --- a/examples/imagenet/alexnet/README.md +++ b/examples/imagenet/alexnet/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # Train AlexNet over ImageNet Convolution neural network (CNN) is a type of feed-forward neural http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/imagenet/densenet/README.md ---------------------------------------------------------------------- diff --git a/examples/imagenet/densenet/README.md b/examples/imagenet/densenet/README.md index 390672f..1ddef0c 100644 --- a/examples/imagenet/densenet/README.md +++ b/examples/imagenet/densenet/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> --- name: DenseNet models on ImageNet SINGA version: 1.1.1 http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/imagenet/googlenet/README.md ---------------------------------------------------------------------- diff --git a/examples/imagenet/googlenet/README.md b/examples/imagenet/googlenet/README.md index e597fc6..4a1335b 100644 --- a/examples/imagenet/googlenet/README.md +++ b/examples/imagenet/googlenet/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> --- name: GoogleNet on ImageNet SINGA version: 1.0.1 http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/imagenet/inception/README.md ---------------------------------------------------------------------- diff --git a/examples/imagenet/inception/README.md b/examples/imagenet/inception/README.md index f129edc..0f5c317 100644 --- a/examples/imagenet/inception/README.md +++ b/examples/imagenet/inception/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> --- name: Inception V4 on ImageNet SINGA version: 1.1.1 http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/imagenet/resnet/README.md ---------------------------------------------------------------------- diff --git a/examples/imagenet/resnet/README.md b/examples/imagenet/resnet/README.md index 9ea12cd..75fb215 100644 --- a/examples/imagenet/resnet/README.md +++ b/examples/imagenet/resnet/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> --- name: Resnets on ImageNet SINGA version: 1.1 http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/imagenet/vgg/README.md ---------------------------------------------------------------------- diff --git a/examples/imagenet/vgg/README.md b/examples/imagenet/vgg/README.md index b6236cf..12aeacc 100644 --- a/examples/imagenet/vgg/README.md +++ b/examples/imagenet/vgg/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> --- name: VGG models on ImageNet SINGA version: 1.1.1 http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/examples/mnist/README.md ---------------------------------------------------------------------- diff --git a/examples/mnist/README.md b/examples/mnist/README.md index 60a85e0..6d91380 100644 --- a/examples/mnist/README.md +++ b/examples/mnist/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # Train a RBM model against MNIST dataset This example is to train an RBM model using the http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/tool/conda/cpu/README.md ---------------------------------------------------------------------- diff --git a/tool/conda/cpu/README.md b/tool/conda/cpu/README.md index 39f21b7..0cf97f7 100644 --- a/tool/conda/cpu/README.md +++ b/tool/conda/cpu/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> The conda package specification includes the package name (i.e. singa), version and build string (could be very long). To install a certain Singa package, we run http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/tool/conda/gpu/README.md ---------------------------------------------------------------------- diff --git a/tool/conda/gpu/README.md b/tool/conda/gpu/README.md index 5fc00cf..e38a446 100644 --- a/tool/conda/gpu/README.md +++ b/tool/conda/gpu/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> The conda package specification includes the package name (i.e. singa), version and build string (could be very long). To install a certain Singa package we run http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/tool/conda/singa/README.md ---------------------------------------------------------------------- diff --git a/tool/conda/singa/README.md b/tool/conda/singa/README.md index 393330c..0a3f42d 100644 --- a/tool/conda/singa/README.md +++ b/tool/conda/singa/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # Package Singa using conda-build [conda-build](https://conda.io/docs/user-guide/tasks/build-packages/index.html) is a packaging tool like apt-get, which is associated with [anaconda cloud](https://anaconda.org/) for package management for both python and cpp libraries. @@ -31,4 +49,3 @@ You will see the package path from the screen output. To clean the cache conda clean -ay - http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/tool/docker/README.md ---------------------------------------------------------------------- diff --git a/tool/docker/README.md b/tool/docker/README.md index 06ce0e9..c95ab49 100644 --- a/tool/docker/README.md +++ b/tool/docker/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # SINGA Docker Images ## Availabe images @@ -18,7 +36,3 @@ cudaxxx images have installed all depedent libs using apt-get. docker pull nusdbsystem/singa:<Tag> docker run -it nusdbsystem/singa:<Tag> /bin/bash nvidia-docker run -it nusdbsystem/singa:<Tag> /bin/bash - - - - http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/24d11899/tool/jenkins/README.md ---------------------------------------------------------------------- diff --git a/tool/jenkins/README.md b/tool/jenkins/README.md index dc5ec56..26275e8 100644 --- a/tool/jenkins/README.md +++ b/tool/jenkins/README.md @@ -1,3 +1,21 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> # Jenkins CI Support ## Introduction @@ -52,7 +70,7 @@ The building script can do the following tasks: Execute shell - command - ``git push https://<username:token>@github.com/nusdbsystem/incubator-singa.git -f`` * create conda package and upload it to anaconda cloud - Execute shell - command + Execute shell - command /root/miniconda/bin/conda-build tool/conda/singa /root/miniconda/bin/anaconda -t <ANACONDA_UPLOAD_TOKEN> upload -u nusdbsystem -l main /root/miniconda/linux-64/singa-*.so.*.tar.bz2 --force @@ -125,7 +143,7 @@ It does the following tasks, The Jenkins job configuration is similar as above except the following fields, * Source Code Management - Git - Additional Behaviors - Include Region `doc/*` -* Build - Execute Shell - Command +* Build - Execute Shell - Command bash -ex tool/jenkins/gen_doc.sh @@ -135,12 +153,12 @@ The Jenkins job configuration is similar as above except the following fields, The docker images used for testing also be used for document generation. We have to manually configure something inside the docker container. -First, we start the container +First, we start the container $docker run --name singa-doc -d <docker image> # docker network connect jenkins singa-doc $ docker exec -it singa-doc /bin/bash - + Next, we do the first commit to the svn repo. $ svn co https://svn.apache.org/repos/asf/incubator/singa/site/trunk
