tree: 21413e1c792a812c71150a6ca67507b2c2080865 [path history] [tgz]
  1. Algorithms Reference/
  2. Gemfile
  3. Language Reference/
  4. README.md
  5. _config.yml
  6. _layouts/
  7. algorithms-bibliography.md
  8. algorithms-classification.md
  9. algorithms-clustering.md
  10. algorithms-descriptive-statistics.md
  11. algorithms-matrix-factorization.md
  12. algorithms-reference.md
  13. algorithms-regression.md
  14. algorithms-survival-analysis.md
  15. beginners-guide-python.md
  16. beginners-guide-to-dml-and-pydml.md
  17. contributing-to-systemml.md
  18. css/
  19. debugger-guide.md
  20. devdocs/
  21. developer-tools-systemml.md
  22. dml-language-reference.md
  23. engine-dev-guide.md
  24. files/
  25. hadoop-batch-mode.md
  26. img/
  27. index.md
  28. jmlc.md
  29. js/
  30. release-process.md
  31. spark-batch-mode.md
  32. spark-mlcontext-programming-guide.md
  33. standalone-guide.md
  34. troubleshooting-guide.md
docs/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
$ 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