|
1 | 1 | deeplearning4j-docs |
2 | 2 | =================== |
3 | 3 |
|
4 | | -The documentation for Deeplearning4j and all of its libraries (DL4J, ND4J, Arbiter, DataVec, etc.) live in this repository. |
5 | | - |
6 | | -**Warning: DO NOT edit the user guide directly in this repository. Commits will be reverted. Please make changes to the main repository [here](https://github.com/eclipse/deeplearning4j/tree/master/docs), run the autogeneration process, and open a pull request.** |
7 | | - |
8 | | -## Developing |
9 | | - |
10 | | -The site is hosted on Github pages and when files are merged to the default branch `gh-pages` a Jekyll server hosted by Github automatically generates the static content and publishes them to the deeplearning4j.org domain. |
11 | | - |
12 | | -To develop and test site content locally, you must have the following tools installed on your system: |
13 | | - |
14 | | -- Ruby (suggest using `rbenv`) |
15 | | -- NodeJS/NPM |
16 | | - |
17 | | -Once you have Ruby and NPM installed on your local machine, navigate to the root directory of this repostory and then run: |
18 | | - |
19 | | -```shell |
20 | | -rbenv install 2.3.1 |
21 | | -gem install jekyll bundler |
22 | | -npm install |
23 | | -bundle install |
24 | | -``` |
25 | | - |
26 | | -This will ensure tools such as Gulp are installed to your local filesystem. |
27 | | - |
28 | | -### Mandatory Headers |
29 | | - |
30 | | -Because the DL4J website uses descriptions and categories to enhance the user experience, all web pages will need to use jekyll headers. For most pages, the `default` template is fine. |
31 | | - |
32 | | -```yaml |
33 | | ---- |
34 | | -title: Deeplearning4j Autoencoders |
35 | | -short_title: Autoencoders |
36 | | -description: Supported autoencoder configurations. |
37 | | -layout: default |
38 | | ---- |
39 | | -``` |
40 | | - |
41 | | -Note that the user guide also uses Jekyll headers with some specific changes. Please see the README for autogen docs for more information: https://github.com/eclipse/deeplearning4j/blob/master/docs/README.md. |
42 | | - |
43 | | -### Running Locally |
44 | | - |
45 | | -If you want to start up a server that hot reloads web content after edits, run the following two commands in parallel from the root of this repository (such as two terminal windows): |
46 | | - |
47 | | -```shell |
48 | | -bundle exec jekyll serve |
49 | | -``` |
50 | | - |
51 | | -```shell |
52 | | -gulp watch |
53 | | -``` |
54 | | - |
55 | | -### Regenerating Tutorials |
56 | | - |
57 | | -Tutorials are converted from Jupyter notebooks with the extension `.ipynb` in the examples repository, and generated into pages directly accessible on the docs website. If you need to update the tutorials, run the command: |
58 | | - |
59 | | -```shell |
60 | | -cd utils |
61 | | -export DL4J_TUTORIALS_DIR=/path/to/dl4j-examples/tutorials/ |
62 | | -bash convert_tutorials.sh |
63 | | -``` |
64 | | - |
65 | | -The conversion script will handle everything automatically. |
| 4 | +This website has migrated to https://deeplearning4j.konduit.ai/ please proceed to the new website. |
0 commit comments