Skip to content

Commit

Permalink
some tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
afgambin committed Sep 10, 2024
1 parent 5518500 commit 082b161
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
20 changes: 10 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@
Charmed MLflow documentation
============================

Charmed MLflow is a platform for managing the end-to-end machine learning lifecycle.
Charmed MLflow is a platform for managing the end-to-end Machine Learning (ML) lifecycle.

It provides tools for tracking experiments, packaging code into reproducible runs, and sharing and deploying models. It integrates with popular machine learning frameworks.
It provides tools for tracking experiments, packaging code into reproducible runs, and sharing and deploying models.
It integrates with popular ML frameworks.

It addresses a number of common machine learning challenges: collaboration, reproducibility, maintenance, organisation and scaling.
It also addresses a number of common ML challenges including collaboration, reproducibility, maintenance, organisation and scaling.

It's ideal for data scientists, ML engineers, hobbyists and teams looking to optimise their ML workflows with charms.
It is intended for data scientists and ML engineers, looking to optimise their ML workflows with charms.

---------

Expand All @@ -29,7 +30,6 @@ In this documentation
**Step-by-step guides** covering key operations and common tasks in Charmed MLflow

.. grid:: 1 1 2 2
:reverse:

.. grid-item:: :doc:`Explanation <explanation/index>`

Expand All @@ -42,11 +42,11 @@ Project and community

Charmed MLflow is an open-source project that values its community. We warmly welcome contributions, suggestions, fixes, and constructive feedback from everyone.

* `Code of conduct`_
* `Contribute`_
* `Join our online chat`_
* `Upstream Project`_
* `Discourse Forum`_
* Read our `Code of conduct`_.
* `Contribute`_ and `report bugs <https://github.com/canonical/mlflow-operator/issues/new/choose>`_.
* Join the `Discourse forum`_.
* `Talk to us`_.
* Learn more about the `upstream project`_.

.. toctree::
:hidden:
Expand Down
6 changes: 3 additions & 3 deletions docs/reuse/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
.. _Example product documentation: https://canonical-example-product-documentation.readthedocs-hosted.com/

.. _Code of conduct: https://ubuntu.com/community/ethos/code-of-conduct
.. _Join our online chat: https://chat.charmhub.io/charmhub/channels/charmed-mlops
.. _Talk to us: https://chat.charmhub.io/charmhub/channels/charmed-mlops
.. _Contribute: https://github.com/canonical/mlflow-operator/blob/main/CONTRIBUTING.md
.. _Upstream Project: https://mlflow.org/
.. _Discourse Forum: https://discourse.charmhub.io/tag/mlflow
.. _Upstream project: https://mlflow.org/
.. _Discourse forum: https://discourse.charmhub.io/tag/mlflow
.. _rclone: https://snapcraft.io/rclone
.. _configured: https://rclone.org/s3/#configuration
.. _yq binary: https://snapcraft.io/yq
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/mlflow-kubeflow.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Get started with Charmed MLflow and Kubeflow
================================================
============================================

+-----------+---------+
| Component | Version |
Expand Down

0 comments on commit 082b161

Please sign in to comment.