"git@developer.sourcefind.cn:OpenDAS/vision.git" did not exist on "f3aff2fa60c110c25df671b6f99ffb26727cb8ae"
Commit 0efd2aad authored by Minjie Wang's avatar Minjie Wang
Browse files

update readme to include document url

parent 5552b60a
...@@ -2,62 +2,6 @@ ...@@ -2,62 +2,6 @@
[![Build Status](http://216.165.71.225:8080/buildStatus/icon?job=DGL/master)](http://216.165.71.225:8080/job/DGL/job/master/) [![Build Status](http://216.165.71.225:8080/buildStatus/icon?job=DGL/master)](http://216.165.71.225:8080/job/DGL/job/master/)
[![GitHub license](https://dmlc.github.io/img/apache2.svg)](./LICENSE) [![GitHub license](https://dmlc.github.io/img/apache2.svg)](./LICENSE)
## Architecture
Show below, there are three sets of APIs for different models.
- `update_all`, `proppagate` are more global
- `update_by_edge`, `update_to` and `update_from` give finer control when updates are applied to a path, or a group of nodes
- `sendto` and `recvfrom` are the bottom primitives that update a message and node.
![Screenshot](graph-api.png) For how to install and how to play with DGL, please read our
[Documentation](http://216.165.71.225:23232/index.html)
## For Model developers
- Always choose the API at the *highest* possible level.
- Refer to the [GCN example](examples/pytorch/gcn/gcn_batch.py) to see how to register message and node update functions;
## How to build (the `cpp` branch)
Before building, make sure that the submodules are cloned. If you haven't initialized the submodules, run
```sh
$ git submodule init
```
To sync the submodules, run
```sh
$ git submodule update
```
### Linux
At the root directory of the repo:
```sh
$ mkdir build
$ cd build
$ cmake ..
$ make
$ export DGL_LIBRARY_PATH=$PWD
```
The `DGL_LIBRARY_PATH` environment variable should point to the library `libdgl.so` built by CMake.
### Windows/MinGW (Experimental)
Make sure you have the following installed:
* CMake
* MinGW/GCC (G++)
* MinGW/Make
You can grab them from Anaconda.
In the command line prompt, run:
```
> md build
> cd build
> cmake -DCMAKE_CXX_FLAGS="-DDMLC_LOG_STACK_TRACE=0 -DTVM_EXPORTS" .. -G "MinGW Makefiles"
> mingw32-make
> set DGL_LIBRARY_PATH=%CD%
```
...@@ -72,3 +72,23 @@ built above. Use following command to test whether the installation is successfu ...@@ -72,3 +72,23 @@ built above. Use following command to test whether the installation is successfu
Install from docker Install from docker
------------------- -------------------
TBD TBD
Install on Windows/MinGW
------------------------
Make sure you have the following installed:
* CMake
* MinGW/GCC (G++)
* MinGW/Make
You can grab them from Anaconda.
In the command line prompt, run:
.. code:: bash
md build
cd build
cmake -DCMAKE_CXX_FLAGS="-DDMLC_LOG_STACK_TRACE=0 -DTVM_EXPORTS" .. -G "MinGW Makefiles"
mingw32-make
set DGL_LIBRARY_PATH=%CD%
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment