Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
divi255 committed Apr 11, 2023
1 parent 2f1fb3a commit 9556147
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
14 changes: 7 additions & 7 deletions eva-mlkit/client/py/pydoc/pydoc_ml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. py:module:: evaics.ml
.. py:class:: HistoryDF(client, params_csv: ~typing.Optional[str] = None)
.. py:class:: HistoryDF(client, params_csv: Optional[str] = None)
:module: evaics.ml

Fetches data from EVA ICS v4 history databases
Expand All @@ -28,7 +28,7 @@
:param database: database name (db service without eva.db. prefix)


.. py:method:: HistoryDF.fetch(t_col: str = 'keep', tz: str = 'local', output='arrow', strict_col_order=False)
.. py:method:: HistoryDF.fetch(t_col: str = 'keep', tz: str = 'local', output='arrow', strict_col_order=True)
:module: evaics.ml

Fetch data
Expand All @@ -39,7 +39,7 @@
drop the time column
tz: time zone (local, custom or None to keep time column as UNIX
timestamp), the default is "local"
strict_col_order: force strict column ordering
strict_col_order: force strict column ordering (default: True)


:returns: a prepared Pandas DataFrame object
Expand All @@ -65,7 +65,7 @@
:param limit: max number of rows


.. py:method:: HistoryDF.oid(oid: ~typing.Union[~evaics.sdk.OID, str], status=False, value=False, database=None, xopts=None)
.. py:method:: HistoryDF.oid(oid: Union[evaics.sdk.OID, str], status=False, value=False, database=None, xopts=None)
:module: evaics.ml

Append OID for processing
Expand Down Expand Up @@ -102,23 +102,23 @@
:param f: file path or buffer


.. py:method:: HistoryDF.t_end(t_end: ~typing.Union[float, str])
.. py:method:: HistoryDF.t_end(t_end: Union[float, str])
:module: evaics.ml

Specify the data frame end time

:param t_start: a float (timestamp), a string or a datetime object


.. py:method:: HistoryDF.t_start(t_start: ~typing.Union[float, str, ~datetime.datetime])
.. py:method:: HistoryDF.t_start(t_start: Union[float, str, datetime.datetime])
:module: evaics.ml

Specify the data frame start time

:param t_start: a float (timestamp), a string or a datetime object


.. py:method:: HistoryDF.with_mlkit(mlkit: ~typing.Union[bool, str])
.. py:method:: HistoryDF.with_mlkit(mlkit: Union[bool, str])
:module: evaics.ml

Set ML kit url/svc name
Expand Down
2 changes: 1 addition & 1 deletion eva-mlkit/server/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ configuration:
gzip on;
gzip_min_length 8192;
gzip_proxied no-cache no-store private expired auth;
gzip_types text/plain text/css text/csv;
gzip_types application/vnd.apache.arrow.stream text/csv;
gzip_vary on;
proxy_buffers 16 16k;
proxy_buffer_size 16k;
Expand Down
2 changes: 2 additions & 0 deletions eva-mlkit/share/svc-tpl-mlsrv.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ config:
listen: 0.0.0.0:8811
# max response data size, per request
response_max_size: 1_000_000_000
# default RPC clients pool for requests to a particular db svc
default_rpc_clients: 4
## if a front-end server or TLS terminator is used
#real_ip_header: X-Real-IP
# HMI service, used for authentication, required
Expand Down

0 comments on commit 9556147

Please sign in to comment.