Skip to content

Commit

Permalink
Fix markdown issues (mlflow#1369)
Browse files Browse the repository at this point in the history
  • Loading branch information
aarondav authored May 31, 2019
1 parent bd2811a commit 4866f5a
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 51 deletions.
70 changes: 30 additions & 40 deletions docs/source/R-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -381,11 +381,11 @@ Extracts the ID of the run or experiment.
Arguments
---------

+------------+----------------------------------------------------+
| Argument | Description |
+============+====================================================+
| ``object`` | An ``mlflow_run`` or ``mlflow_experiment`` object. |
+------------+----------------------------------------------------+
========== ==================================================
Argument Description
========== ==================================================
``object`` An ``mlflow_run`` or ``mlflow_experiment`` object.
========== ==================================================

``mlflow_list_artifacts``
=========================
Expand Down Expand Up @@ -893,17 +893,13 @@ to be used by package authors to extend the supported MLflow models.
Arguments
---------

+-----------------------------------+-----------------------------------+
| Argument | Description |
+===================================+===================================+
| ``model`` | The loaded MLflow model flavor. |
+-----------------------------------+-----------------------------------+
| ``data`` | A data frame to perform scoring. |
+-----------------------------------+-----------------------------------+
| ``...`` | Optional additional arguments |
| | passed to underlying predict |
| | methods. |
+-----------------------------------+-----------------------------------+
========= ===================================================================
Argument Description
========= ===================================================================
``model`` The loaded MLflow model flavor.
``data`` A data frame to perform scoring.
``...`` Optional additional arguments passed to underlying predict methods.
========= ===================================================================

``mlflow_rename_experiment``
============================
Expand Down Expand Up @@ -1211,20 +1207,14 @@ model types.
Arguments
---------

+-----------------------------------+-----------------------------------+
| Argument | Description |
+===================================+===================================+
| ``model`` | The model that will perform a |
| | prediction. |
+-----------------------------------+-----------------------------------+
| ``path`` | Destination path where this |
| | MLflow compatible model will be |
| | saved. |
+-----------------------------------+-----------------------------------+
| ``...`` | Optional additional arguments. |
+-----------------------------------+-----------------------------------+
| ``conda_env`` | Path to Conda dependencies file. |
+-----------------------------------+-----------------------------------+
============= ==================================================================
Argument Description
============= ==================================================================
``model`` The model that will perform a prediction.
``path`` Destination path where this MLflow compatible model will be saved.
``...`` Optional additional arguments.
``conda_env`` Path to Conda dependencies file.
============= ==================================================================

``mlflow_search_runs``
======================
Expand Down Expand Up @@ -1403,11 +1393,11 @@ experiments.
Arguments
---------

+----------+--------------------------------------+
| Argument | Description |
+==========+======================================+
| ``uri`` | The URI to the remote MLflow server. |
+----------+--------------------------------------+
======== ====================================
Argument Description
======== ====================================
``uri`` The URI to the remote MLflow server.
======== ====================================

``mlflow_source``
=================
Expand All @@ -1426,11 +1416,11 @@ called via ``Rscript`` from the terminal or through the MLflow CLI.
Arguments
---------

+----------+----------------------------------------------------------+
| Argument | Description |
+==========+==========================================================+
| ``uri`` | Path to an R script, can be a quoted or unquoted string. |
+----------+----------------------------------------------------------+
======== ========================================================
Argument Description
======== ========================================================
``uri`` Path to an R script, can be a quoted or unquoted string.
======== ========================================================

``mlflow_start_run``
====================
Expand Down
4 changes: 2 additions & 2 deletions docs/source/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ Docker container environment

Environment variables, such as ``MLFLOW_TRACKING_URI``, are propagated inside the Docker container
during project execution. Additionally, :ref:`runs <concepts>` and
:ref:`experiments <organizing-runs-in-experiments>` created by the project are saved to the
tracking server specified by your :ref:`tracking URI <where-runs-are-recorded>`. When running
:ref:`experiments <organizing_runs_in_experiments>` created by the project are saved to the
tracking server specified by your :ref:`tracking URI <where_runs_are_recorded>`. When running
against a local tracking URI, MLflow mounts the host system's tracking directory
(e.g., a local ``mlruns`` directory) inside the container so that metrics, parameters, and
artifacts logged during project execution are accessible afterwards.
Expand Down
2 changes: 1 addition & 1 deletion mlflow/h2o.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
def get_default_conda_env():
"""
:return: The default Conda environment for MLflow Models produced by calls to
:func:`save_model()` and :func:`log_model()`.
:func:`save_model()` and :func:`log_model()`.
"""
import h2o

Expand Down
2 changes: 1 addition & 1 deletion mlflow/keras.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
def get_default_conda_env():
"""
:return: The default Conda environment for MLflow Models produced by calls to
:func:`save_model()` and :func:`log_model()`.
:func:`save_model()` and :func:`log_model()`.
"""
import keras
import tensorflow as tf
Expand Down
5 changes: 2 additions & 3 deletions mlflow/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,8 @@ def predict(self, model_uri, input_path, output_path, content_type, json_format)
:param json_format: Only applies if content_type == 'json'. Specifies how is the input data
encoded in json. Can be one of {'split', 'records'} mirroring the
behavior of Pandas orient attribute. The default is 'split' which
expects dict like data: {'index' -> [index],
'columns' -> [columns],
'data' -> [values]}, where index is optional.
expects dict like data: ``{'index' -> [index], 'columns' -> [columns],
'data' -> [values]}``, where index is optional.
For more information see "https://pandas.pydata.org/
pandas-docs/stable/reference/api/pandas.read_json.html"
"""
Expand Down
1 change: 1 addition & 0 deletions mlflow/pyfunc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,7 @@ def spark_udf(spark, model_uri, result_type="double"):
:class:`pyspark.sql.types.DataType` object or a DDL-formatted type string.
Only a primitive type or an array (pyspark.sql.types.ArrayType) of primitive
types are allowed. The following classes of result type are supported:
- "int" or pyspark.sql.types.IntegerType: The leftmost integer that can fit
in int32 result is returned or exception is raised if there is none.
- "long" or pyspark.sql.types.LongType: The leftmost long integer that can
Expand Down
2 changes: 1 addition & 1 deletion mlflow/pytorch/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
def get_default_conda_env():
"""
:return: The default Conda environment for MLflow Models produced by calls to
:func:`save_model()` and :func:`log_model()`.
:func:`save_model()` and :func:`log_model()`.
"""
import torch
import torchvision
Expand Down
2 changes: 1 addition & 1 deletion mlflow/sklearn.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
def get_default_conda_env(include_cloudpickle=False):
"""
:return: The default Conda environment for MLflow Models produced by calls to
:func:`save_model()` and :func:`log_model()`.
:func:`save_model()` and :func:`log_model()`.
"""
import sklearn
pip_deps = None
Expand Down
2 changes: 1 addition & 1 deletion mlflow/spark.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
def get_default_conda_env():
"""
:return: The default Conda environment for MLflow Models produced by calls to
:func:`save_model()` and :func:`log_model()`.
:func:`save_model()` and :func:`log_model()`.
"""
import pyspark

Expand Down
2 changes: 1 addition & 1 deletion mlflow/tensorflow.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
def get_default_conda_env():
"""
:return: The default Conda environment for MLflow Models produced by calls to
:func:`save_model()` and :func:`log_model()`.
:func:`save_model()` and :func:`log_model()`.
"""
import tensorflow as tf
return _mlflow_conda_env(
Expand Down

0 comments on commit 4866f5a

Please sign in to comment.