Skip to content

Commit 597fa7d

Browse files
Srivatsan RamanujamRahul Iyer
authored andcommitted
ReadMe: Add new markdown version of ReadMe
1 parent f5610e8 commit 597fa7d

File tree

6 files changed

+64
-0
lines changed

6 files changed

+64
-0
lines changed

CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/license"
174174
install(
175175
FILES
176176
"${CMAKE_CURRENT_SOURCE_DIR}/ReadMe.txt"
177+
"${CMAKE_CURRENT_SOURCE_DIR}/README.md"
177178
"${CMAKE_CURRENT_SOURCE_DIR}/ReleaseNotes.txt"
178179
DESTINATION doc
179180
COMPONENT core

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
![](./doc/imgs/magnetic-icon.png) ![](./doc/imgs/agile-icon.png) ![](./doc/imgs/deep-icon.png)
2+
=================================================
3+
**MADlib** is an open-source library for scalable in-database analytics.
4+
It provides data-parallel implementations of mathematical, statistical and
5+
machine learning methods for structured and unstructured data.
6+
7+
Installation and Contribution
8+
==============================
9+
See the project webpage [`MADlib Home`](http://madlib.net) for links to the
10+
latest binary and source packages. For installation and contribution guides,
11+
please see [`MADlib Wiki`](https://github.com/madlib/madlib/wiki)
12+
13+
User and Developer Documentation
14+
==================================
15+
The latest documentation of MADlib modules can be found at [`MADlib
16+
Docs`](http://doc.madlib.net) or can be accessed directly from the MADlib
17+
installation directory by opening
18+
[`doc/user/html/index.html`](doc/user/html/index.html).
19+
20+
21+
Architecture
22+
=============
23+
The following block-diagram gives a high-level overview of MADlib's
24+
architecture.
25+
26+
27+
![MADlib Architecture](./doc/imgs/architecture.png)
28+
29+
30+
Third Party Components
31+
======================
32+
MADlib incorporates material from the following third-party components
33+
34+
1. [`argparse 1.2.1`](http://code.google.com/p/argparse/) "provides an easy, declarative interface for creating command line tools"
35+
2. [`Boost 1.46.1 (or newer)`](http://www.boost.org/) "provides peer-reviewed portable C++ source libraries"
36+
3. [`CERN ROOT`](http://root.cern.ch/) "is an object oriented framework for large scale data analysis"
37+
4. [`doxypy 0.4.2`](http://code.foosel.org/doxypy) "is an input filter for Doxygen"
38+
5. [`Eigen 3.0.3`](http://eigen.tuxfamily.org/index.php?title=Main_Page) "is a C++ template library for linear algebra"
39+
6. [`PyYAML 3.10`](http://pyyaml.org/wiki/PyYAML) "is a YAML parser and emitter for Python"
40+
41+
Licensing
42+
==========
43+
License information regarding MADlib and included third-party libraries can be
44+
found inside the [`license`](/license) directory.
45+
46+
Release Notes
47+
=============
48+
Changes between MADlib versions are described in the
49+
[`ReleaseNotes.txt`](/ReleaseNotes.txt) file.
50+
51+
Papers and Talks
52+
=================
53+
* [`MAD Skills : New Analysis Practices for Big Data (VLDB 2009)`](http://db.cs.berkeley.edu/papers/vldb09-madskills.pdf)
54+
55+
56+
Related Software
57+
=================
58+
* [`PivotalR`](https://github.com/madlib-internal/PivotalR) - PivotalR also lets
59+
the user to run the functions of the open-source big-data machine learning
60+
package `MADlib` directly from R.
61+
* [`PyMADlib`](https://github.com/gopivotal/pymadlib) - PyMADlib is a python
62+
wrapper for MADlib, which brings you the power and flexibility of python
63+
with the number crunching power of `MADlib`.

doc/imgs/agile-icon.png

6.7 KB
Loading

doc/imgs/architecture.png

158 KB
Loading

doc/imgs/deep-icon.png

8.37 KB
Loading

doc/imgs/magnetic-icon.png

8.14 KB
Loading

0 commit comments

Comments
 (0)