update index page and readme; test preview on github
Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/d007dc67 Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/d007dc67 Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/d007dc67 Branch: refs/heads/gh-pages Commit: d007dc67bdca6331d6f5defabc6faaef4f32dd84 Parents: 666a841 Author: wang wei <[email protected]> Authored: Thu May 7 20:17:20 2015 +0800 Committer: wang wei <[email protected]> Committed: Thu May 7 20:17:20 2015 +0800 ---------------------------------------------------------------------- README.md | 42 ++++-------------------------- _config.yml | 2 +- _includes/themes/twitter/default.html | 13 ++++----- _posts/docs/2015-01-10-quick-start.md | 6 ++--- index.md | 10 ++++++- 5 files changed, 25 insertions(+), 48 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/d007dc67/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 6a90c81..30b6805 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,8 @@ -# Jekyll-Bootstrap - -The quickest way to start and publish your Jekyll powered blog. 100% compatible with GitHub pages - -## Usage - -For all usage and documentation please see: <http://jekyllbootstrap.com> - -## Version - -0.3.0 - stable and versioned using [semantic versioning](http://semver.org/). - -**NOTE:** 0.3.0 introduces a new theme which is not backwards compatible in the sense it won't _look_ like the old version. -However, the actual API has not changed at all. -You might want to run 0.3.0 in a branch to make sure you are ok with the theme design changes. - -## Contributing - - -To contribute to the framework please make sure to checkout your branch based on `jb-development`!! -This is very important as it allows me to accept your pull request without having to publish a public version release. - -Small, atomic Features, bugs, etc. -Use the `jb-development` branch but note it will likely change fast as pull requests are accepted. -Please rebase as often as possible when working. -Work on small, atomic features/bugs to avoid upstream commits affecting/breaking your development work. - -For Big Features or major API extensions/edits: -This is the one case where I'll accept pull-requests based off the master branch. -This allows you to work in isolation but it means I'll have to manually merge your work into the next public release. -Translation : it might take a bit longer so please be patient! (but sincerely thank you). - -**Jekyll-Bootstrap Documentation Website.** - -The documentation website at <http://jekyllbootstrap.com> is maintained at https://github.com/plusjade/jekyllbootstrap.com +## Edit and Preview the Website + jekyll serve --config _config.yml,_config-prod.yml ## License - -[MIT](http://opensource.org/licenses/MIT) +* We used Jekyll-Boostrap [MIT](http://opensource.org/licenses/MIT) to generate this website. +* The source code except that from Jekyll-Boostrap is release under +[Apache License 2](http://www.apache.org/licenses/LICENSE-2.0.html). http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/d007dc67/_config.yml ---------------------------------------------------------------------- diff --git a/_config.yml b/_config.yml index 32634db..c6fbf12 100644 --- a/_config.yml +++ b/_config.yml @@ -54,7 +54,7 @@ JB : # - When setting BASE_PATH it must be a valid url. # This means always setting the protocol (http|https) or prefixing with "/" # - BASE_PATH : "/singa" #http://www.comp.nus.edu.sg/~wangwei + BASE_PATH : "/incubator-singa" #http://www.comp.nus.edu.sg/~wangwei # By default, the asset_path is automatically defined relative to BASE_PATH plus the enabled theme. # ex: [BASE_PATH]/assets/themes/[THEME-NAME] http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/d007dc67/_includes/themes/twitter/default.html ---------------------------------------------------------------------- diff --git a/_includes/themes/twitter/default.html b/_includes/themes/twitter/default.html index 6074ac0..8dc80bf 100644 --- a/_includes/themes/twitter/default.html +++ b/_includes/themes/twitter/default.html @@ -79,12 +79,6 @@ </head> <body> - <a href="https://github.com/apache/incubator-singa"><img style="position: absolute; top: 0; - left: 0; border: 0;" - src="https://camo.githubusercontent.com/8b6b8ccc6da3aa5722903da7b58eb5ab1081adee/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f6c6566745f6f72616e67655f6666373630302e706e67" - alt="Fork me on GitHub" - data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_left_orange_ff7600.png"></a> - <div id="topanchor"></div> <div class="navbar"> <div class="navbar-inner"> @@ -98,6 +92,13 @@ </div> </div> </div> + <a href="https://github.com/apache/incubator-singa" style="float: left"><img style="position: relative; top: 40px; + left: 0; border: 0;" + src="https://camo.githubusercontent.com/8b6b8ccc6da3aa5722903da7b58eb5ab1081adee/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f6c6566745f6f72616e67655f6666373630302e706e67" + alt="Fork me on GitHub" + data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_left_orange_ff7600.png"></a> + + <div class="container-narrow"> <div class="content"> {{ content }} http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/d007dc67/_posts/docs/2015-01-10-quick-start.md ---------------------------------------------------------------------- diff --git a/_posts/docs/2015-01-10-quick-start.md b/_posts/docs/2015-01-10-quick-start.md index bf953ba..6862419 100644 --- a/_posts/docs/2015-01-10-quick-start.md +++ b/_posts/docs/2015-01-10-quick-start.md @@ -50,10 +50,10 @@ Download the dataset and create the data shards for training and testing. cd examples/cifar10/ make download - make shard + make create A training dataset and a test dataset are created under *train-shard* and -*test-shard* folder respectively. A mena.shard file is also generated, which +*test-shard* folder respectively. A image_mean.bin file is also generated, which contains the feature mean of all images. <!--After creating the data shards, you to update the paths in the model configuration file (*model.conf*) for the @@ -87,7 +87,7 @@ Start the training by running: #goto top level folder cd .. - ./build/singa -model=examples/cifar10/model.conf -cluster=examples/cifar10/cluster.conf + ./singa -model=examples/cifar10/model.conf -cluster=examples/cifar10/cluster.conf #### Training with data Partitioning http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/d007dc67/index.md ---------------------------------------------------------------------- diff --git a/index.md b/index.md index c72732a..ad914b7 100644 --- a/index.md +++ b/index.md @@ -10,8 +10,16 @@ Please follow the [quick start]({{ BASE_PATH }}{% post_url /docs/2015-01-10-quic guide to download, install and run SINGA. ### Documentation +* Documentations are listed [here]({{ BASE_PATH }}/docs.html). * Code API can be found [here]({{ BASE_PATH }}/api/index.html). -* Documentations are listed [here]({{ BASE_PATH }}/docs.html) + +### Contribute + +* Please subscribe to our development mailing list [email protected]. +* If you find any issues using SIGNA, please report it to the +[Issue Tracker](https://issues.apache.org/jira/browse/singa). + +More details on contributing to SINGA is describe [here]({{ BASE_PATH }}/community.html). ### License SINGA is released under [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
