Skip to content

Commit

Permalink
Update README and documentation index page (dask#816)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
hristog authored Apr 4, 2021
1 parent 80eb0d8 commit f5e5bb4
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 9 deletions.
39 changes: 31 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
dask-ml
Dask-ML
=======

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

.. image:: https://dev.azure.com/dask-dev/dask/_apis/build/status/dask.dask-ml?branchName=main
:target: https://dev.azure.com/dask-dev/dask/_build/latest?definitionId=1&branchName=main
:alt: CI Status
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.

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

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/dask/dask-examples/main?filepath=machine-learning.ipynb

.. _dask: https://dask.org
.. _documentation: http://ml.dask.org
LICENSE
-------

New BSD. See `License File <https://github.com/dask/dask-ml/blob/main/LICENSE.txt>`__.

.. _documentation: https://dask.org
.. |Build Status| image:: https://github.com/dask/dask-ml/workflows/CI/badge.svg?branch=main
:target: https://github.com/dask/dask-ml/actions?query=workflow%3A%22CI%22
.. |Azure Pipelines| image:: https://dev.azure.com/dask-dev/dask/_apis/build/status/dask.dask-ml?branchName=main
:target: https://dev.azure.com/dask-dev/dask/_build/latest?definitionId=1&branchName=main
.. |Coverage| image:: https://codecov.io/gh/dask/dask-ml/branch/main/graph/badge.svg
:target: https://codecov.io/gh/dask/dask-ml/branch/main
:alt: Coverage status
.. |Doc Status| image:: https://readthedocs.org/projects/ml/badge/?version=latest
:target: https://ml.dask.org/
:alt: Documentation Status
.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/dask/dask
:target: https://gitter.im/dask/dask?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |Version Status| image:: https://img.shields.io/pypi/v/dask-ml.svg
:target: https://pypi.python.org/pypi/dask-ml/
.. |NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
:target: https://www.numfocus.org/
3 changes: 2 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Dask-ML
=======

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

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

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

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

0 comments on commit f5e5bb4

Please sign in to comment.