diff --git a/docs/index.md b/docs/index.md index 9292390..74b3d43 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,10 +29,10 @@ cd dist-keras pip install -e . ``` -## Architecture - ## Getting Started +After the installation process is complete, you can start exploring the functionality by browsing the examples. We have also prepared a notebook which basically compares the different distributed optimizers with each other. This notebook is located at `examples/experiment.ipynb`. However, other examples are also provided which show you how to use the different distributed optimizers with Apache Spark for distributed pre-processing. + ## References * Zhang, S., Choromanska, A. E., & LeCun, Y. (2015). Deep learning with elastic averaging SGD. In Advances in Neural Information Processing Systems (pp. 685-693). diff --git a/docs/optimizers.md b/docs/optimizers.md new file mode 100644 index 0000000..68bfaee --- /dev/null +++ b/docs/optimizers.md @@ -0,0 +1 @@ +# Optimizers diff --git a/mkdocs.yml b/mkdocs.yml index ace6155..48dd491 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,8 +7,8 @@ site_url: 'http://dist-keras.joerihermans.com' # Page definitions. pages: - Home: index.md +- Optimizers: optimizers.md - License: license.md - # Documentation and theme configuration theme: material docs_dir: 'docs' @@ -16,7 +16,6 @@ markdown_extensions: - admonition extra: version: '0.1.0' - logo: 'images/logo.png' palette: primary: 'grey' accent: 'light blue'