Per the announcement at Data Science Summit, the license will be changing to BSD! Between that and other changes, there will be major restructuring of this repository in the near future. The target date for the re-release is mid to end August. If you plan to fork and modify the code, be aware that you may need to port your changes forward soon.
In the meantime to try out SFrame/SGraph, download and install our graphlab-create python package.
Dato Core is the open source piece of GraphLab Create, a Python-based machine learning platform that enables data scientists and app developers to easily create intelligent apps at scale: from prototype to production.
For more details on the GraphLab Create see http://dato.com, including documentation, tutorials, etc.
The Dato Open Source project provides the complete implementation for
- SFrame v1 and v2 format reader and writers
- SFrame query evaluator
- SGraph
- Graph Analytics implementations
- The implementations of the C++ SDK surface area (gl_sframe, gl_sarray, gl_sgraph)
Included within the release are also a large number of utility code such as:
- Sketch implementations
- Serialization
- flexible_type (efficient runtime typed object)
- C++ interprocess communication library (used for C++ <--> Python communication)
- PowerGraph's RPC implementation
The python client code is licensed under a BSD license. See DATO-PYTHON-LICENSE file. The rest of the code is licensed under a GNU Affero General Public License. See license file.
We will keep the open sourced components up to date with the latest released version of GraphLab Create by issuing a large "version update" pull request with every new version of GraphLab Create.
The utility code is generally stable and will not change significantly over time. The SFrame v1 and v2 formats are considered stable. A v3 format is in the works to introduce greater compression and performance. The query evaluator is in the midst of a complete rearchitecting.
GraphLab Create now automatically satisfied most dependencies. There are however, a few dependencies which we cannot easily satisfy:
-
On OS X: Apple XCode 6 Command Line Tools [Required]
- Required for compiling GraphLab Create.
-
On Linux: g++ (>= 4.8) or clang (>= 3.4) [Required]
- Required for compiling GraphLab Create.
-
*nix build tools: patch, make [Required]
- Should come with most Mac/Linux systems by default. Recent Ubuntu version will require to install the build-essential package.
-
cython [Required]
- For compilation of GraphLab Create
-
zlib [Required]
- Comes with most Mac/Linux systems by default. Recent Ubuntu version will require the zlib1g-dev package.
-
JDK 6 or greater [Optional]
- Required for HDFS support
-
Open MPI or MPICH2 [Optional]
- Required only for the RPC library inherited from PowerGraph
Install XCode 6 with the command line tools. Then: brew install automake brew install autoconf brew install cmake
In Ubuntu >= 12.10, you can satisfy the dependencies with: All the dependencies can be satisfied from the repository:
sudo apt-get install gcc g++ build-essential libopenmpi-dev default-jdk cmake zlib1g-dev \
libatlas-base-dev automake autoconf python-dev
sudo pip install cython
For Ubuntu versions prior to 12.10, you will need to install a newer version of gcc
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt-get install gcc-4.8 g++-4.8 build-essential libopenmpi-dev default-jdk cmake zlib1g-dev
#redirect g++ to point to g++-4.8
sudo rm /usr/bin/g++
sudo ln -s /usr/bin/g++-4.8 /usr/bin/g++
./configure
Running configure will create two sub-directories, release and debug. Select either of these modes/directories and navigate to the src/unity subdirectory:
cd <repo root>/debug/src/unity
or
cd <repo root>/release/src/unity
Running make will build the project, according to the mode selected.
We recommend using make's parallel build feature to accelerate the compilation process. For instance:
make -j 4
will perform up to 4 build tasks in parallel. When building in release mode/directory, GraphLab Create does require a large amount of memory to compile with the heaviest toolkit requiring 1GB of RAM. Where K is the amount of memory you have on your machine in GB, we recommend not exceeding make -j K
To generate the python code bindings,
Navigate to the python subdirectories and run make to generate Python code bindings. Remember to replace <repo root> with the absolute path to the root of your repository.
cd <repo root>/debug/src/unity/python
make
or
cd <repo root>/release/src/unity/python
make
To use your dev build export these environment variables:
export GRAPHLAB_UNITY="<repo root>/debug/src/unity/server/unity_server"
Then run pip install to pull in dependencies and set the python path.
# recommended -- use a virtual environment
virtualenv venv
. venv/bin/activate
# required -- pip install the built Python package with -e
pip install -e .
The built Python package is now available for use in the current Python environment. As you make changes and run make again, the package will update in place (no need to re-create the virtualenv or pip install again).
From the repo root:
cd <repo root>/debug/src/unity/python/graphlab/test
nosetests
From the repo root:
cd <repo root>/debug/test
make
ctest