You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@systemml.apache.org by GitBox <gi...@apache.org> on 2020/04/07 11:38:04 UTC

[GitHub] [systemml] Baunsgaard opened a new pull request #877: SystemDS Documentation

Baunsgaard opened a new pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877
 
 
   Brute change of documentation page to reflect name change.
   
   To fully enforce this two more steps are needed:
   
   1. https://github.com/apache/systemml-website
   2. Access to SystemML website server on https://systemml.apache.org/ 
   
   Furthermore, we might want to consider starting fresh in the documentation.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] Baunsgaard commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
Baunsgaard commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r405390846
 
 

 ##########
 File path: .gitignore
 ##########
 @@ -0,0 +1,15 @@
+.classpath
+.jekyll-cache/
+.project
+_site/
+Gemfile.lock
+
+## VS Code
+
+.settings/
+.vscode/
+
+## Inproper copy when switching branch
+
+target/
+src/
 
 Review comment:
   Also removed it from this pull request.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] Baunsgaard commented on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
Baunsgaard commented on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610861056
 
 
   When switching the MLContext to DSContext it does not allign with the new python.
   These again, have to be rewritten.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] Baunsgaard edited a comment on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
Baunsgaard edited a comment on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610861056
 
 
   When switching the MLContext to DSContext it does not align with the new python.
   These again, have to be rewritten.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 edited a comment on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 edited a comment on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610732106
 
 
   Hi @Baunsgaard,  priliminary comments:
   
   - [x] Documentation _name refactoring_ can be done on feature by feature basis.
   
     i.e.,
           > 1. changing all the `MLLearn` related naming at once
           > 2. and going for `MLContext` related in the next step
     this would help us get through this more sanely. or if you have confidence we would still go with the present changes. :)
   -  [ ] Also, renaming of the following files can be considered (exhaustive list)
   1. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   2. [contributing-to-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-7c60d52419aa7274236adc2abd084484)
   3. [alg-ref/SystemML_Algorithms_Reference.tex](https://github.com/apache/systemml/pull/877/files#diff-7a90e6afce66bf963deeb423d0db9a6c)
   4. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   
   Thank you.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r406572994
 
 

 ##########
 File path: deep-learning.md
 ##########
 @@ -29,21 +29,21 @@ limitations under the License.
 
 # Introduction
 
-There are three different ways to implement a Deep Learning model in SystemML:
+There are three different ways to implement a Deep Learning model in SystemDS:
 1. Using the [DML-bodied NN library](https://github.com/apache/systemml/tree/master/scripts/nn): This library allows the user to exploit full flexibility of [DML language](http://apache.github.io/systemml/dml-language-reference) to implement your neural network.
-2. Using the experimental [Caffe2DML API](http://apache.github.io/systemml/beginners-guide-caffe2dml.html): This API allows a model expressed in Caffe's proto format to be imported into SystemML. This API **doesnot** require Caffe to be installed on your SystemML.
-3. Using the experimental [Keras2DML API](http://apache.github.io/systemml/beginners-guide-keras2dml.html): This API allows a model expressed in Keras's API to be imported into SystemML. However, this API requires Keras to be installed on your driver.
+2. Using the experimental [Caffe2DML API](http://apache.github.io/systemml/beginners-guide-caffe2dml.html): This API allows a model expressed in Caffe's proto format to be imported into SystemDS. This API **doesnot** require Caffe to be installed on your SystemDS.
+3. Using the experimental [Keras2DML API](http://apache.github.io/systemml/beginners-guide-keras2dml.html): This API allows a model expressed in Keras's API to be imported into SystemDS. However, this API requires Keras to be installed on your driver.
 
 |                                                                                                      | NN library                                                                                                 | Caffe2DML                                                                                                     | Keras2DML                                                                       |
 |------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
 | External dependency                                                                                  | None                                                                                                       | None                                                                                                          | Keras                                                                           |
 | Ability to add custom layers                                                                         | Yes                                                                                                        | No                                                                                                            | No                                                                              |
 | The user needs to know                                                                               | [DML](http://apache.github.io/systemml/dml-language-reference)                                             | [Caffe's proto API](http://apache.github.io/systemml/reference-guide-caffe2dml#layers-supported-in-caffe2dml) | [Keras' API](https://keras.io/models/about-keras-models/)                       |
-| Can be invoked using pyspark                                                                         | Yes. Please see [Python MLContext API](http://apache.github.io/systemml/spark-mlcontext-programming-guide) | Yes.                                                                                                          | Yes.                                                                            |
-| Can be invoked using spark-shell                                                                     | Yes. Please see [Scala MLContext API](http://apache.github.io/systemml/spark-mlcontext-programming-guide)  | Limited support                                                                                               | No                                                                              |
+| Can be invoked using pyspark                                                                         | Yes. Please see [Python DSContext API](http://apache.github.io/systemml/spark-mlcontext-programming-guide) | Yes.                                                                                                          | Yes.                                                                            |
 
 Review comment:
   Can this `MLContext` -> `DLContext` change be reverted, as discussed.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610868265
 
 
   
   > * [ ]  Also, renaming of the following files can be considered (exhaustive list)
   > 
   > 1. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   > 2. [contributing-to-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-7c60d52419aa7274236adc2abd084484)
   > 3. [alg-ref/SystemML_Algorithms_Reference.tex](https://github.com/apache/systemml/pull/877/files#diff-7a90e6afce66bf963deeb423d0db9a6c)
   > 4. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   
   Also can this be done. thanks.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610867367
 
 
   Hey!
   > When switching the MLContext to DSContext it does not allign with the new python.
   > These again, have to be rewritten.
   
   it seems `MLContext` is not changed in SystemDS. So, the last two commits can be reverted
   1. [5dc3528](https://github.com/apache/systemml/pull/877/commits/5dc35285695d70fa161078d804a959546dfd4c37)
   2. [639009b](https://github.com/apache/systemml/pull/877/commits/639009b547e4258594f031d8ed7155a208c84647)
   
   And although this PR is good. Let us wait for a day (till 9th of April) more for others to chime in with comments.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] asfgit closed pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877
 
 
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 edited a comment on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 edited a comment on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610868265
 
 
   
   > * [x]  Also, renaming of the following files can be considered (exhaustive list)
   > 
   > 1. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   > 2. [contributing-to-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-7c60d52419aa7274236adc2abd084484)
   > 3. [alg-ref/SystemML_Algorithms_Reference.tex](https://github.com/apache/systemml/pull/877/files#diff-7a90e6afce66bf963deeb423d0db9a6c)
   > 4. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   
   Also can this be done. thanks.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r406572994
 
 

 ##########
 File path: deep-learning.md
 ##########
 @@ -29,21 +29,21 @@ limitations under the License.
 
 # Introduction
 
-There are three different ways to implement a Deep Learning model in SystemML:
+There are three different ways to implement a Deep Learning model in SystemDS:
 1. Using the [DML-bodied NN library](https://github.com/apache/systemml/tree/master/scripts/nn): This library allows the user to exploit full flexibility of [DML language](http://apache.github.io/systemml/dml-language-reference) to implement your neural network.
-2. Using the experimental [Caffe2DML API](http://apache.github.io/systemml/beginners-guide-caffe2dml.html): This API allows a model expressed in Caffe's proto format to be imported into SystemML. This API **doesnot** require Caffe to be installed on your SystemML.
-3. Using the experimental [Keras2DML API](http://apache.github.io/systemml/beginners-guide-keras2dml.html): This API allows a model expressed in Keras's API to be imported into SystemML. However, this API requires Keras to be installed on your driver.
+2. Using the experimental [Caffe2DML API](http://apache.github.io/systemml/beginners-guide-caffe2dml.html): This API allows a model expressed in Caffe's proto format to be imported into SystemDS. This API **doesnot** require Caffe to be installed on your SystemDS.
+3. Using the experimental [Keras2DML API](http://apache.github.io/systemml/beginners-guide-keras2dml.html): This API allows a model expressed in Keras's API to be imported into SystemDS. However, this API requires Keras to be installed on your driver.
 
 |                                                                                                      | NN library                                                                                                 | Caffe2DML                                                                                                     | Keras2DML                                                                       |
 |------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
 | External dependency                                                                                  | None                                                                                                       | None                                                                                                          | Keras                                                                           |
 | Ability to add custom layers                                                                         | Yes                                                                                                        | No                                                                                                            | No                                                                              |
 | The user needs to know                                                                               | [DML](http://apache.github.io/systemml/dml-language-reference)                                             | [Caffe's proto API](http://apache.github.io/systemml/reference-guide-caffe2dml#layers-supported-in-caffe2dml) | [Keras' API](https://keras.io/models/about-keras-models/)                       |
-| Can be invoked using pyspark                                                                         | Yes. Please see [Python MLContext API](http://apache.github.io/systemml/spark-mlcontext-programming-guide) | Yes.                                                                                                          | Yes.                                                                            |
-| Can be invoked using spark-shell                                                                     | Yes. Please see [Scala MLContext API](http://apache.github.io/systemml/spark-mlcontext-programming-guide)  | Limited support                                                                                               | No                                                                              |
+| Can be invoked using pyspark                                                                         | Yes. Please see [Python DSContext API](http://apache.github.io/systemml/spark-mlcontext-programming-guide) | Yes.                                                                                                          | Yes.                                                                            |
 
 Review comment:
   Can this `MLContext` -> `DLContext` change be reverted, as discussed (https://github.com/apache/systemml/pull/877#issuecomment-610867367)

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] Baunsgaard commented on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
Baunsgaard commented on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610873871
 
 
   > > * [ ]   Also, renaming of the following files can be considered (exhaustive list)
   > > 
   > > 
   > > 1. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   > > 2. [contributing-to-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-7c60d52419aa7274236adc2abd084484)
   > > 3. [alg-ref/SystemML_Algorithms_Reference.tex](https://github.com/apache/systemml/pull/877/files#diff-7a90e6afce66bf963deeb423d0db9a6c)
   > > 4. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   > 
   > Also can this be done. thanks.
   
   1. and 4. is the same. 
   
   and the change in latex is somewhat larger.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 edited a comment on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 edited a comment on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610732106
 
 
   Hi @Baunsgaard,  priliminary comments:
   
   - [x] Documentation _name refactoring_ can be done on feature by feature basis.
   
     i.e.,
           > 1. changing all the `MLLearn` related naming at once
           > 2. and going for `MLContext` related in the next step
     this would help us get through this more sanely. or if you have confidence we would still go with the present changes. :)
   -  [x] Also, renaming of the following files can be considered (exhaustive list)
   1. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   2. [contributing-to-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-7c60d52419aa7274236adc2abd084484)
   3. [alg-ref/SystemML_Algorithms_Reference.tex](https://github.com/apache/systemml/pull/877/files#diff-7a90e6afce66bf963deeb423d0db9a6c)
   4. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   
   Thank you.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] Baunsgaard commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
Baunsgaard commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r405389855
 
 

 ##########
 File path: .gitignore
 ##########
 @@ -0,0 +1,15 @@
+.classpath
+.jekyll-cache/
+.project
+_site/
+Gemfile.lock
+
+## VS Code
+
+.settings/
+.vscode/
+
+## Inproper copy when switching branch
+
+target/
+src/
 
 Review comment:
   https://github.com/apache/systemml/pull/879

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r406572259
 
 

 ##########
 File path: _config.yml
 ##########
 @@ -15,7 +15,7 @@ exclude:
   - lang-ref
 
 # These allow the documentation to be updated with newer releases
-SYSTEMML_VERSION: 1.3.0-SNAPSHOT
+SYSTEMDS_VERSION: 2.0.0-SNAPSHOT
 
 Review comment:
   I remember seeing `0.3.0-SNAPSHOT` during mvn build, not sure what the decision was.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] Baunsgaard commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
Baunsgaard commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r405391317
 
 

 ##########
 File path: README.md
 ##########
 @@ -17,26 +17,49 @@ limitations under the License.
 {% endcomment %}
 -->
 
-# Apache SystemML Documentation
+# Apache SystemDS Documentation
 
-The primary SystemML documentation is written in markdown (*.md) and can be converted to HTML using
+The primary SystemDS documentation is written in markdown (*.md) and can be converted to HTML using
 [Jekyll](http://jekyllrb.com).
 
-Jekyll (and optionally Pygments) can be installed on the Mac OS in the following manner.
+## Ubuntu Install
+
+1. Install Ruby development environment [Jekyll on Ubuntu](https://jekyllrb.com/docs/installation/ubuntu/).
+2. Install Jekyll inside the Ruby environnement.
+
+   - `gem install jekyll jekyll-redirect-from bundler pygments.rb`
+   - To do this you might need to change permissions on folders `/var/lib/gems` and `/var/lib/gems/2.5.0`.
+   - The Pygments package is optional, and does require sudo permissions.
+
+3. Install python dependencies (Optionally).
+
+   - `pip install Pygments`
 
-    $ brew install ruby
-    $ gem install jekyll
-    $ gem install jekyll-redirect-from
-    $ gem install bundler
-    $ brew install python
-    $ pip install Pygments
-    $ gem install pygments.rb
+4. Launch the Documentation locally
+
+   - `jekyll serve -w`
+   - This is done from the root of the gh-pages branch of the system.
+   - The serving will per default be on localhost port 4000 [Link](http://localhost:4000)
+
+## Mac Install (Depricated)
 
 Review comment:
   Done

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-611036577
 
 
   1. can this be `.gitignore` removed, 
   2. Does it help opening new pull request for `README.md`? - Yes!
   3. So the present pull request can be renamed to **[MINOR] Name Refactor `SystemML` to `SystemDS`**
     a. `_layouts/global.html` 1 file
     b.  `alg-ref/*.tex` - 19 files
                  ` .gitignore` - 1 file
                   `*.bib` - 1 file
      c. `algorithms-*.md` - 9 files
      d. `beginner-guide-*.md` - 4 files
   
   Feel free to breakdown this task into any (upto 5Nos.) of steps, so that each step can be reviewed crystal clear. thanks.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] Baunsgaard commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
Baunsgaard commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r406789932
 
 

 ##########
 File path: _config.yml
 ##########
 @@ -15,7 +15,7 @@ exclude:
   - lang-ref
 
 # These allow the documentation to be updated with newer releases
-SYSTEMML_VERSION: 1.3.0-SNAPSHOT
+SYSTEMDS_VERSION: 2.0.0-SNAPSHOT
 
 Review comment:
   This is still up for debate, as discussed in the emails.
   In my opinion the 2.0 seems the cleanest, since that wouldn't change previous releases.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-610732106
 
 
   Hi @Baunsgaard,  priliminary comments:
   
   - [ ] Documentation _name refactoring_ can be done on feature by feature basis.
   
     i.e.,
           > 1. changing all the `MLLearn` related naming at once
           > 2. and going for `MLContext` related in the next step
     this would help us get through this more sanely. or if you have confidence we would still go with the present changes. :)
   -  [ ] Also, renaming of the following files can be considered (exhaustive list)
   1. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   2. [contributing-to-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-7c60d52419aa7274236adc2abd084484)
   3. [alg-ref/SystemML_Algorithms_Reference.tex](https://github.com/apache/systemml/pull/877/files#diff-7a90e6afce66bf963deeb423d0db9a6c)
   4. [developer-tools-systemml.md](https://github.com/apache/systemml/pull/877/files#diff-5a20cd23dee2cf3706698331acae778e)
   
   Thank you.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] Baunsgaard commented on issue #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
Baunsgaard commented on issue #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#issuecomment-611130915
 
 
   >     1. can this be `.gitignore` removed,
   > 
   >     2. Does it help opening new pull request for `README.md`? - Yes!
   > 
   >     3. So the present pull request can be renamed to **[MINOR] Name Refactor `SystemML` to `SystemDS`**
   >        a. `_layouts/global.html` 1 file
   >        b.  `alg-ref/*.tex` - 19 files
   >        ` .gitignore` - 1 file
   >        `*.bib` - 1 file
   >        c. `algorithms-*.md` - 9 files
   >        d. `beginner-guide-*.md` - 4 files
   > 
   > 
   > Feel free to breakdown this task into any (upto 5Nos.) of steps, so that each step can be reviewed crystal clear. thanks.
   
   1. No, my error should be fixed now.
   2. Will do
   3. Not sure what you want, but i think it makes the most sense to keep the refactor together.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r405241622
 
 

 ##########
 File path: .gitignore
 ##########
 @@ -0,0 +1,15 @@
+.classpath
+.jekyll-cache/
+.project
+_site/
+Gemfile.lock
+
+## VS Code
+
+.settings/
+.vscode/
+
+## Inproper copy when switching branch
+
+target/
+src/
 
 Review comment:
   Hi, can this _.gitignore_ file be moved in another PR?.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [systemml] j143 commented on a change in pull request #877: SystemDS Documentation

Posted by GitBox <gi...@apache.org>.
j143 commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r405240804
 
 

 ##########
 File path: README.md
 ##########
 @@ -17,26 +17,49 @@ limitations under the License.
 {% endcomment %}
 -->
 
-# Apache SystemML Documentation
+# Apache SystemDS Documentation
 
-The primary SystemML documentation is written in markdown (*.md) and can be converted to HTML using
+The primary SystemDS documentation is written in markdown (*.md) and can be converted to HTML using
 [Jekyll](http://jekyllrb.com).
 
-Jekyll (and optionally Pygments) can be installed on the Mac OS in the following manner.
+## Ubuntu Install
+
+1. Install Ruby development environment [Jekyll on Ubuntu](https://jekyllrb.com/docs/installation/ubuntu/).
+2. Install Jekyll inside the Ruby environnement.
+
+   - `gem install jekyll jekyll-redirect-from bundler pygments.rb`
+   - To do this you might need to change permissions on folders `/var/lib/gems` and `/var/lib/gems/2.5.0`.
+   - The Pygments package is optional, and does require sudo permissions.
+
+3. Install python dependencies (Optionally).
+
+   - `pip install Pygments`
 
-    $ brew install ruby
-    $ gem install jekyll
-    $ gem install jekyll-redirect-from
-    $ gem install bundler
-    $ brew install python
-    $ pip install Pygments
-    $ gem install pygments.rb
+4. Launch the Documentation locally
+
+   - `jekyll serve -w`
+   - This is done from the root of the gh-pages branch of the system.
+   - The serving will per default be on localhost port 4000 [Link](http://localhost:4000)
+
+## Mac Install (Depricated)
 
 Review comment:
   _Deprecated_ is more popular though.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services