[DOCS] Update link to readme (#3437)
This commit is contained in:
parent
aec6299c49
commit
e62639c59b
7
.github/ISSUE_TEMPLATE.md
vendored
Normal file
7
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
Thanks for participating in the XGBoost community! We use https://discuss.xgboost.ai for any general usage questions and discussions. The issue tracker is used for actionable items such as feature proposals discussion, roadmaps, and bug tracking. You are always welcomed to post on the forum first :)
|
||||||
|
|
||||||
|
Issues that are inactive for a period of time may get closed. We adopt this policy so that we won't lose track of actionable issues that may fall at the bottom of the pile. Feel free to reopen a new one if you feel there is an additional problem that needs attention when an old one gets closed.
|
||||||
|
|
||||||
|
For bug reports, to help the developer act on the issues, please include a description of your environment, preferably a minimum script to reproduce the problem.
|
||||||
|
|
||||||
|
For feature proposals, list clear, small actionable items so we can track the progress of the change.
|
||||||
@ -1,44 +0,0 @@
|
|||||||
For bugs or installation issues, please provide the following information.
|
|
||||||
The more information you provide, the more easily we will be able to offer
|
|
||||||
help and advice.
|
|
||||||
|
|
||||||
## Environment info
|
|
||||||
Operating System:
|
|
||||||
|
|
||||||
Compiler:
|
|
||||||
|
|
||||||
Package used (python/R/jvm/C++):
|
|
||||||
|
|
||||||
`xgboost` version used:
|
|
||||||
|
|
||||||
If installing from source, please provide
|
|
||||||
|
|
||||||
1. The commit hash (`git rev-parse HEAD`)
|
|
||||||
2. Logs will be helpful (If logs are large, please upload as attachment).
|
|
||||||
|
|
||||||
If you are using jvm package, please
|
|
||||||
|
|
||||||
1. add [jvm-packages] in the title to make it quickly be identified
|
|
||||||
2. the gcc version and distribution
|
|
||||||
|
|
||||||
If you are using python package, please provide
|
|
||||||
|
|
||||||
1. The python version and distribution
|
|
||||||
2. The command to install `xgboost` if you are not installing from source
|
|
||||||
|
|
||||||
If you are using R package, please provide
|
|
||||||
|
|
||||||
1. The R `sessionInfo()`
|
|
||||||
2. The command to install `xgboost` if you are not installing from source
|
|
||||||
|
|
||||||
## Steps to reproduce
|
|
||||||
|
|
||||||
1.
|
|
||||||
2.
|
|
||||||
3.
|
|
||||||
|
|
||||||
## What have you tried?
|
|
||||||
|
|
||||||
1.
|
|
||||||
2.
|
|
||||||
3.
|
|
||||||
35
README.md
35
README.md
@ -10,42 +10,25 @@
|
|||||||
|
|
||||||
[Documentation](https://xgboost.readthedocs.org) |
|
[Documentation](https://xgboost.readthedocs.org) |
|
||||||
[Resources](demo/README.md) |
|
[Resources](demo/README.md) |
|
||||||
[Installation](https://xgboost.readthedocs.org/en/latest/build.html) |
|
[Contributors](CONTRIBUTORS.md) |
|
||||||
[Release Notes](NEWS.md) |
|
[Community](https://xgboost.ai/community) |
|
||||||
[RoadMap](https://github.com/dmlc/xgboost/issues/873)
|
[Release Notes](NEWS.md)
|
||||||
|
|
||||||
XGBoost is an optimized distributed gradient boosting library designed to be highly ***efficient***, ***flexible*** and ***portable***.
|
XGBoost is an optimized distributed gradient boosting library designed to be highly ***efficient***, ***flexible*** and ***portable***.
|
||||||
It implements machine learning algorithms under the [Gradient Boosting](https://en.wikipedia.org/wiki/Gradient_boosting) framework.
|
It implements machine learning algorithms under the [Gradient Boosting](https://en.wikipedia.org/wiki/Gradient_boosting) framework.
|
||||||
XGBoost provides a parallel tree boosting (also known as GBDT, GBM) that solve many data science problems in a fast and accurate way.
|
XGBoost provides a parallel tree boosting (also known as GBDT, GBM) that solve many data science problems in a fast and accurate way.
|
||||||
The same code runs on major distributed environment (Hadoop, SGE, MPI) and can solve problems beyond billions of examples.
|
The same code runs on major distributed environment (Hadoop, SGE, MPI) and can solve problems beyond billions of examples.
|
||||||
|
|
||||||
What's New
|
|
||||||
----------
|
|
||||||
* [XGBoost GPU support with fast histogram algorithm](https://github.com/dmlc/xgboost/tree/master/plugin/updater_gpu)
|
|
||||||
* [XGBoost4J: Portable Distributed XGboost in Spark, Flink and Dataflow](http://dmlc.ml/2016/03/14/xgboost4j-portable-distributed-xgboost-in-spark-flink-and-dataflow.html), see [JVM-Package](https://github.com/dmlc/xgboost/tree/master/jvm-packages)
|
|
||||||
* [Story and Lessons Behind the Evolution of XGBoost](http://homes.cs.washington.edu/~tqchen/2016/03/10/story-and-lessons-behind-the-evolution-of-xgboost.html)
|
|
||||||
* [Tutorial: Distributed XGBoost on AWS with YARN](https://xgboost.readthedocs.io/en/latest/tutorials/aws_yarn.html)
|
|
||||||
* [XGBoost brick](NEWS.md) Release
|
|
||||||
|
|
||||||
Ask a Question
|
|
||||||
--------------
|
|
||||||
* For reporting bugs please use the [xgboost/issues](https://github.com/dmlc/xgboost/issues) page.
|
|
||||||
* For generic questions or to share your experience using XGBoost please use the [XGBoost User Group](https://groups.google.com/forum/#!forum/xgboost-user/)
|
|
||||||
|
|
||||||
Help to Make XGBoost Better
|
|
||||||
---------------------------
|
|
||||||
XGBoost has been developed and used by a group of active community members. Your help is very valuable to make the package better for everyone.
|
|
||||||
- Check out [call for contributions](https://github.com/dmlc/xgboost/issues?q=is%3Aissue+label%3Acall-for-contribution+is%3Aopen) and [Roadmap](https://github.com/dmlc/xgboost/issues/873) to see what can be improved, or open an issue if you want something.
|
|
||||||
- Contribute to the [documents and examples](https://github.com/dmlc/xgboost/blob/master/doc/) to share your experience with other users.
|
|
||||||
- Add your stories and experience to [Awesome XGBoost](demo/README.md).
|
|
||||||
- Please add your name to [CONTRIBUTORS.md](CONTRIBUTORS.md) and after your patch has been merged.
|
|
||||||
- Please also update [NEWS.md](NEWS.md) on changes and improvements in API and docs.
|
|
||||||
|
|
||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
© Contributors, 2016. Licensed under an [Apache-2](https://github.com/dmlc/xgboost/blob/master/LICENSE) license.
|
© Contributors, 2016. Licensed under an [Apache-2](https://github.com/dmlc/xgboost/blob/master/LICENSE) license.
|
||||||
|
|
||||||
|
Contribute to XGBoost
|
||||||
|
---------------------
|
||||||
|
XGBoost has been developed and used by a group of active community members. Your help is very valuable to make the package better for everyone.
|
||||||
|
Checkout the [Community Page](https://xgboost.ai/community)
|
||||||
|
|
||||||
Reference
|
Reference
|
||||||
---------
|
---------
|
||||||
- Tianqi Chen and Carlos Guestrin. [XGBoost: A Scalable Tree Boosting System](http://arxiv.org/abs/1603.02754). In 22nd SIGKDD Conference on Knowledge Discovery and Data Mining, 2016
|
- Tianqi Chen and Carlos Guestrin. [XGBoost: A Scalable Tree Boosting System](http://arxiv.org/abs/1603.02754). In 22nd SIGKDD Conference on Knowledge Discovery and Data Mining, 2016
|
||||||
- XGBoost originates from research project at University of Washington, see also the [Project Page at UW](http://dmlc.cs.washington.edu/xgboost.html).
|
- XGBoost originates from research project at University of Washington.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user