Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring of the Getting Started page #10798

Merged
merged 3 commits into from Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
304 changes: 90 additions & 214 deletions docs/source/getting-started/index.rst

Large diffs are not rendered by default.

20 changes: 19 additions & 1 deletion docs/source/getting-started/logging-first-model/index.rst
Expand Up @@ -20,4 +20,22 @@ The topics in this tutorial cover:
* Learning how to **log** metrics, parameters, and a model artifact to a run
* Viewing our Experiment and our first run within the **MLflow UI**

To get started with the tutorial, click NEXT below.
To get started with the tutorial, click NEXT below or navigate to the section that you're interested in:

.. toctree::
:maxdepth: 1

step1-tracking-server
step2-mlflow-client
step3-create-experiment
step4-experiment-search
step5-synthetic-data
step6-logging-a-run
notebooks/index

If you would instead like to download a notebook-based version of this guide and follow along locally, you can download the notebook from the link below.

.. raw:: html

<a href="https://raw.githubusercontent.com/mlflow/mlflow/master/docs/source/getting-started/logging-first-model/notebooks/logging-first-model.ipynb" class="notebook-download-btn">
<i class="fas fa-download"></i>Download the Notebook</a><br/>
340 changes: 0 additions & 340 deletions docs/source/getting-started/quickstart-1/index.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/source/getting-started/quickstart-2/index.rst
Expand Up @@ -26,8 +26,8 @@ you will create a Docker container image suitable for deployment to a cloud plat
Set up
------

- Install MLflow. See the :ref:`introductory quickstart <quickstart-1>` for instructions
- Run the tracking server: ``mlflow ui --port 5000``
For a comprehensive guide on getting an MLflow environment setup that will give you options on how to configure MLflow tracking
capabilities, you can `read the guide here <../running-notebooks/index.html>`_.

Run a hyperparameter sweep
--------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Expand Up @@ -46,7 +46,7 @@ Getting Started Guides and Quickstarts
</a>
</div>
<div class="simple-card">
<a href="getting-started/quickstart-1/index.html" >
<a href="tracking/autolog.html" >
<div class="header">
Autologging Quickstart
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tracking/backend-stores.rst
Expand Up @@ -39,7 +39,7 @@ MLflow supports the following types of tracking URI for backend stores:
- HTTP server (specified as ``https://my-server:5000``), which is a server hosting an :ref:`MLflow tracking server <tracking_server>`.
- Databricks workspace (specified as ``databricks`` or as ``databricks://<profileName>``, a `Databricks CLI profile <https://github.com/databricks/databricks-cli#installation>`_).
Refer to Access the MLflow tracking server from outside Databricks `[AWS] <http://docs.databricks.com/applications/mlflow/access-hosted-tracking-server.html>`_
`[Azure] <http://docs.microsoft.com/azure/databricks/applications/mlflow/access-hosted-tracking-server>`_, or :ref:`the quickstart <quickstart_tracking_server>` to
`[Azure] <http://docs.microsoft.com/azure/databricks/applications/mlflow/access-hosted-tracking-server>`_, or `the quickstart <../getting-started/intro-quickstart/index.html>`_ to
easily get started with hosted MLflow on Databricks Community Edition.

.. important::
Expand Down