Skip to content
This repository has been archived by the owner on May 24, 2018. It is now read-only.

Commit

Permalink
deprecate wormhole
Browse files Browse the repository at this point in the history
  • Loading branch information
tqchen committed Mar 11, 2016
1 parent db96885 commit 3eceda4
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 116 deletions.
58 changes: 10 additions & 48 deletions README.md
Expand Up @@ -4,59 +4,21 @@
[![Documentation Status](https://readthedocs.org/projects/wormhole/badge/?version=latest)](http://wormhole.readthedocs.org/en/latest/)
[![GitHub license](http://dmlc.github.io/img/apache2.svg)](./LICENSE)

Portable, scalable and reliable distributed machine learning.
This repo is deprecated. We have realized that it is much
better to build individual projects that have deep optimization
and integration with the existing system.

Wormhole is a place where DMLC projects works together to provide
scalable and reliable machine learning toolkits that can run on various platforms

Features
====
* Portable:
- Supported platforms: local machine, Apache YARN, MPI and Sungrid Engine
* Rich support of Data Source
- All projects can read data from HDFS, S3 or local filesystem
* Scalable and Reliable
Pointers to the Projects
------------------------
- [XGBoost](https://github.com/dmlc/xgboost) for tree boosting.
- [MXNet](https://github.com/dmlc/mxnet) for for deep learning
- [DiFaco](https://github.com/dmlc/difaco) for factorization.


List of Tools
====
-------------
* Boosted Trees (GBDT): [XGBoost: eXtreme Gradient Boosting](learn/xgboost)
* Clustering: [kmeans](learn/kmeans)
* Linear method: [Asynchrouns SGD](learn/linear) [L-BFGS](learn/lbfgs-linear)
* Factorization Machine: [DiFacto](learn/difacto)

Build & Run
====

* Requires a C++11 compiler (e.g.~`g++ >=4.8`) and `git`. Install them on Ubuntu
>= 13.10
```
sudo apt-get update && sudo apt-get install -y build-essential git libgoogle-glog-dev
```

* Type `make` to build all deps and tools

* All tools can run both in a laptop and in a cluster. For example, train
logisitic regression using 2 workers and one servers in local machine

```
tracker/dmlc_local.py -n 2 -s 1 bin/linear.dmlc learn/linear/guide/demo.conf
```

* [More tutorials and documents](http://wormhole.readthedocs.org/en/latest/index.html)

Support
====

If you are having issues, please let us [know](https://github.com/dmlc/wormhole/issues).


Contribute
====
- We are actively building new tools. The source codes of all tools are available under [learn/](learn).
- Wormhole depends on other DMLC projects, which are also under active developing
- [dmlc-core](https://github.com/dmlc/dmlc-core) provides I/O modules and job
trackers
- [rabit](https://github.com/dmlc/rabit) provides reliable BSP Allreduce communication.
- [ps-lite](https://github.com/dmlc/ps-lite) provides the asynchronous key-value
push and pull for the parameter server framework.
35 changes: 0 additions & 35 deletions learn/xgboost/mushroom.hadoop.conf

This file was deleted.

33 changes: 0 additions & 33 deletions learn/xgboost/run_yarn.sh

This file was deleted.

1 comment on commit 3eceda4

@a-whitej
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mentioned "This repo is deprecated. We have realized that it is much better to build individual projects that have deep optimization and integration with the existing system.", could you please tell what kind of repo has been replaced this repo if the repo has been in github?

Please sign in to comment.