You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@systemml.apache.org by de...@apache.org on 2015/12/15 22:45:10 UTC

incubator-systemml git commit: Update README with info to build distributions

Repository: incubator-systemml
Updated Branches:
  refs/heads/master e25959eef -> f9c6d1607


Update README with info to build distributions

Add Apache license to main README.
Update README with mvn profile command to build distributions.
Add mention of MLContext to execution modes in README.
Add mention of JMLC to execution modes in README.

Closes #22.


Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/f9c6d160
Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/f9c6d160
Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/f9c6d160

Branch: refs/heads/master
Commit: f9c6d1607d121e1e8d7231252bd418c70071ba81
Parents: e25959e
Author: Deron Eriksson <de...@us.ibm.com>
Authored: Mon Dec 14 14:33:48 2015 -0800
Committer: Deron Eriksson <de...@us.ibm.com>
Committed: Tue Dec 15 13:40:08 2015 -0800

----------------------------------------------------------------------
 README.md | 35 ++++++++++++++++++++++++++++++-----
 1 file changed, 30 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/f9c6d160/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 5896553..0110985 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,32 @@
+<!--
+{% comment %}
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+{% endcomment %}
+-->
+
 # SystemML
 
 SystemML is a flexible, scalable machine learning (ML) system.
 SystemML's distinguishing characteristics are: (1) algorithm customizability,
-(2) multiple execution modes, including Standalone, Hadoop Batch, and Spark Batch,
-and (3) automatic optimization.
+(2) multiple execution modes, including Standalone, Hadoop Batch, Spark Batch,
+JMLC, and MLContext, and (3) automatic optimization.
 
 [SystemML](http://systemml.apache.org/) is now an Apache Incubator project.
 The latest project documentation can be found at the 
-[SystemML Documentation](http://apache.github.io/incubator-systemml/) web site on GitHub.
+[SystemML Documentation](http://apache.github.io/incubator-systemml/) website on GitHub.
 
 
 ### Algorithm Customizability
@@ -50,6 +69,10 @@ To build SystemML, run:
 
     mvn clean package
 
+To build the SystemML distributions (`.tar.gz`, `.zip`, etc.), run:
+
+    mvn clean package -P distribution
+
 
 * * *
 
@@ -298,6 +321,8 @@ For convenience, we can encapsulate our DML invocations in a single script:
 	./bin/systemml ./scripts/algorithms/GLM-predict.dml -nvargs X=linRegData.test.data.csv Y=linRegData.test.labels.csv B=betas.csv fmt=csv
 
 
-In this example, we've seen a small part of the capabilities of SystemML. For more detailed information,
-please consult the SystemML Algorithm Reference and SystemML Language Reference.
+In this example, we've seen a small part of the capabilities of SystemML. For more detailed information, please consult the 
+[Apache SystemML (incubating)](http://systemml.apache.org/) website and the
+[SystemML Documentation](http://apache.github.io/incubator-systemml/) website on GitHub.
+