Skip to content

Commit f5e5bb4

Browse files
authored
Update README and documentation index page (#816)
* Add badges and update README and doc index Observations: * The PyPI version is still 1.8.0. This should probably be updated separately. * The Codecov report is still pointing at the `master` branch. The badges are set to point to `main`. The Codecov settings need to be updated accordingly. * Update XGBoost link on doc index page * Update XGBoost link in the README
1 parent 80eb0d8 commit f5e5bb4

File tree

2 files changed

+33
-9
lines changed

2 files changed

+33
-9
lines changed

README.rst

+31-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,35 @@
1-
dask-ml
1+
Dask-ML
22
=======
33

4-
``dask-ml`` is a library for distributed and parallel machine learning using `dask`_.
5-
See the `documentation`_ for more.
4+
|Build Status| |Azure Pipelines| |Coverage| |Doc Status| |Gitter| |Version Status| |NumFOCUS|
65

7-
.. image:: https://dev.azure.com/dask-dev/dask/_apis/build/status/dask.dask-ml?branchName=main
8-
:target: https://dev.azure.com/dask-dev/dask/_build/latest?definitionId=1&branchName=main
9-
:alt: CI Status
6+
Dask-ML provides scalable machine learning in Python using `Dask <https://dask.org/>`__ alongside popular machine learning libraries like `Scikit-Learn <http://scikit-learn.org/>`__, `XGBoost <https://ml.dask.org/xgboost.html>`__, and others.
7+
8+
You can try Dask-ML on a small cloud instance by clicking the following button:
9+
10+
.. image:: https://mybinder.org/badge.svg
11+
:target: https://mybinder.org/v2/gh/dask/dask-examples/main?filepath=machine-learning.ipynb
1012

11-
.. _dask: https://dask.org
12-
.. _documentation: http://ml.dask.org
13+
LICENSE
14+
-------
15+
16+
New BSD. See `License File <https://github.com/dask/dask-ml/blob/main/LICENSE.txt>`__.
17+
18+
.. _documentation: https://dask.org
19+
.. |Build Status| image:: https://github.com/dask/dask-ml/workflows/CI/badge.svg?branch=main
20+
:target: https://github.com/dask/dask-ml/actions?query=workflow%3A%22CI%22
21+
.. |Azure Pipelines| image:: https://dev.azure.com/dask-dev/dask/_apis/build/status/dask.dask-ml?branchName=main
22+
:target: https://dev.azure.com/dask-dev/dask/_build/latest?definitionId=1&branchName=main
23+
.. |Coverage| image:: https://codecov.io/gh/dask/dask-ml/branch/main/graph/badge.svg
24+
:target: https://codecov.io/gh/dask/dask-ml/branch/main
25+
:alt: Coverage status
26+
.. |Doc Status| image:: https://readthedocs.org/projects/ml/badge/?version=latest
27+
:target: https://ml.dask.org/
28+
:alt: Documentation Status
29+
.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
30+
:alt: Join the chat at https://gitter.im/dask/dask
31+
:target: https://gitter.im/dask/dask?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
32+
.. |Version Status| image:: https://img.shields.io/pypi/v/dask-ml.svg
33+
:target: https://pypi.python.org/pypi/dask-ml/
34+
.. |NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
35+
:target: https://www.numfocus.org/

docs/source/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Dask-ML
55
=======
66

77
Dask-ML provides scalable machine learning in Python using Dask_ alongside
8-
popular machine learning libraries like Scikit-Learn_, XGBoost, and others.
8+
popular machine learning libraries like Scikit-Learn_, XGBoost_, and others.
99

1010
You can try Dask-ML on a small cloud instance by clicking the following button:
1111

@@ -132,3 +132,4 @@ See :doc:`Dask-ML + XGBoost <xgboost>` for more information.
132132

133133
.. _Dask: https://dask.org/
134134
.. _Scikit-Learn: http://scikit-learn.org/
135+
.. _XGBoost: https://ml.dask.org/xgboost.html

0 commit comments

Comments
 (0)