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

Refactor dataframe contract helper script into package #823

Merged
merged 1 commit into from
Aug 27, 2019
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions doc/source/python/api/seldon_core.proto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ seldon\_core.proto package
==========================

.. automodule:: seldon_core.proto
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

Submodules
----------
Expand All @@ -13,16 +13,15 @@ seldon\_core.proto.prediction\_pb2 module
-----------------------------------------

.. automodule:: seldon_core.proto.prediction_pb2
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.proto.prediction\_pb2\_grpc module
-----------------------------------------------

.. automodule:: seldon_core.proto.prediction_pb2_grpc
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

95 changes: 51 additions & 44 deletions doc/source/python/api/seldon_core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ seldon\_core package
====================

.. automodule:: seldon_core
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

Subpackages
-----------

.. toctree::

seldon_core.proto
seldon_core.proto

Submodules
----------
Expand All @@ -20,104 +20,111 @@ seldon\_core.api\_tester module
-------------------------------

.. automodule:: seldon_core.api_tester
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.flask\_utils module
--------------------------------

.. automodule:: seldon_core.flask_utils
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.metrics module
---------------------------

.. automodule:: seldon_core.metrics
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.microservice module
--------------------------------

.. automodule:: seldon_core.microservice
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.microservice\_tester module
----------------------------------------

.. automodule:: seldon_core.microservice_tester
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.persistence module
-------------------------------

.. automodule:: seldon_core.persistence
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.seldon\_client module
----------------------------------

.. automodule:: seldon_core.seldon_client
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.seldon\_methods module
-----------------------------------

.. automodule:: seldon_core.seldon_methods
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.serving\_test\_gen module
--------------------------------------

.. automodule:: seldon_core.serving_test_gen
:members:
:undoc-members:
:show-inheritance:

seldon\_core.storage module
---------------------------

.. automodule:: seldon_core.storage
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.user\_model module
-------------------------------

.. automodule:: seldon_core.user_model
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.utils module
-------------------------

.. automodule:: seldon_core.utils
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.version module
---------------------------

.. automodule:: seldon_core.version
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

seldon\_core.wrapper module
---------------------------

.. automodule:: seldon_core.wrapper
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,14 @@ def _column_range(col: pd.Series) -> Optional[List]:
"""
Calculate minimum and maximum of a column and outputs a list.

:param col: Column to inspect.
:return: Min and max of the column range as a list.
Parameters
----------
col
Column to inspect.

Returns
-------
Min and max of the column range as a list.
"""
if col.dtype == np.float:
if pd.isnull(min(col)): # This also means that maximum is null
Expand All @@ -37,8 +43,14 @@ def _column_values(column: pd.Series) -> Union[List, float]:
"""
Create a list of unique values for categorical variables.

:param column: Column to inspect.
:return:
Parameters
----------
column
Column to inspect.

Returns
-------
List of unique values for categorical variables
"""
if column.dtype != np.number:
return column.unique().tolist()
Expand All @@ -50,10 +62,18 @@ def create_seldon_api_testing_file(data: pd.DataFrame, target: str, output_path:
"""
Create a JSON file for Seldon API testing.

:param data: Pandas DataFrame used as a recipe for the json file.
:param target: Name of the target column.
:param output_path: Path of output file.
:return: True if file correctly generated.
Parameters
----------
data
Pandas DataFrame used as a recipe for the json file.
target
Name of the target column.
output_path
Path of output file.

Returns
-------
True if file correctly generated.
"""

# create a Data frame in the form of JSON object
Expand Down