tree: 9f5ea877824d7fb8726c098260bb065af29401aa [path history] [tgz]
  1. _layouts/
  2. alg-ref/
  3. api/
  4. css/
  5. devdocs/
  6. files/
  7. img/
  8. js/
  9. lang-ref/
  10. _config.yml
  11. algorithms-bibliography.html
  12. algorithms-bibliography.md
  13. algorithms-classification.html
  14. algorithms-classification.md
  15. algorithms-clustering.html
  16. algorithms-clustering.md
  17. algorithms-descriptive-statistics.html
  18. algorithms-descriptive-statistics.md
  19. algorithms-matrix-factorization.html
  20. algorithms-matrix-factorization.md
  21. algorithms-reference.html
  22. algorithms-reference.md
  23. algorithms-regression.html
  24. algorithms-regression.md
  25. algorithms-survival-analysis.html
  26. algorithms-survival-analysis.md
  27. beginners-guide-caffe2dml.html
  28. beginners-guide-caffe2dml.md
  29. beginners-guide-keras2dml.html
  30. beginners-guide-keras2dml.md
  31. beginners-guide-python.html
  32. beginners-guide-python.md
  33. beginners-guide-to-dml-and-pydml.html
  34. beginners-guide-to-dml-and-pydml.md
  35. contributing-to-systemml.html
  36. contributing-to-systemml.md
  37. debugger-guide.html
  38. debugger-guide.md
  39. deep-learning.html
  40. deep-learning.md
  41. developer-tools-systemml.html
  42. developer-tools-systemml.md
  43. dml-language-reference.html
  44. dml-language-reference.md
  45. engine-dev-guide.html
  46. engine-dev-guide.md
  47. hadoop-batch-mode.html
  48. hadoop-batch-mode.md
  49. index.html
  50. index.md
  51. jmlc.html
  52. jmlc.md
  53. native-backend.html
  54. native-backend.md
  55. python-performance-test.html
  56. python-performance-test.md
  57. python-reference.html
  58. python-reference.md
  59. README.md
  60. reference-guide-caffe2dml.html
  61. reference-guide-caffe2dml.md
  62. release-creation-process.html
  63. release-creation-process.md
  64. release-process.html
  65. release-process.md
  66. spark-batch-mode.html
  67. spark-batch-mode.md
  68. spark-mlcontext-programming-guide.html
  69. spark-mlcontext-programming-guide.md
  70. standalone-guide.html
  71. standalone-guide.md
  72. troubleshooting-guide.html
  73. troubleshooting-guide.md
content/docs/1.1.0/README.md

Apache SystemML Documentation

The primary SystemML documentation is written in markdown (*.md) and can be converted to HTML using Jekyll.

Jekyll (and optionally Pygments) can be installed on the Mac OS in the following manner.

$ brew install ruby
$ gem install jekyll
$ gem install jekyll-redirect-from
$ gem install bundler
$ brew install python
$ pip install Pygments
$ gem install pygments.rb

For installation on other platforms, please consult the Jekyll documentation.

To generate SystemML documentation in HTML, navigate to the docs folder, the root directory of the documentation. From there, you can have Jekyll convert the markdown files to HTML. If you run in server mode, Jekyll will serve up the generated documentation by default at http://127.0.0.1:4000. Modifications to *.md files will be converted to HTML and can be viewed in a web browser.

$ jekyll serve -w