update of docs

Author: ea-rus

docs/source/conf.py

@@ -16,7 +16,11 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.autosectionlabel'
+]
 
 templates_path = ['_templates']
 exclude_patterns = []

docs/source/index.rst

@@ -90,7 +90,7 @@ Base usage
     More
 
 More examples
------------
+-------------
 
 `<https://github.com/mindsdb/mindsdb_python_sdk/examples>`_
 
@@ -107,12 +107,13 @@ API documentation
    :maxdepth: 1
    :caption: Modules:
 
-
    server
    database
+
+   project
    handlers
+
    ml_engines
-   project
    model
    tables
    views

docs/source/jobs.rst

@@ -1,6 +1,9 @@
 Jobs
 -------------------------
 
+.. _my-reference-label:
+
+
 .. automodule:: mindsdb_sdk.jobs
    :members:
    :undoc-members:

docs/source/server.rst

@@ -4,4 +4,7 @@ Server
 .. automodule:: mindsdb_sdk.server
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+
+
+   :ref:`jobs<Jobs>`

mindsdb_sdk/connect.py

@@ -20,17 +20,17 @@ def connect(url: str = None, login: str = None, password: str = None, is_managed
 
     Connect to local server
 
-    >>> server = mindsdb_sdk.connect()
-    >>> server = mindsdb_sdk.connect('http://127.0.0.1:47334')
+    >>> con = mindsdb_sdk.connect()
+    >>> con = mindsdb_sdk.connect('http://127.0.0.1:47334')
 
     Connect to cloud server
 
-    >>> server = mindsdb_sdk.connect(login='a@b.com', password='-')
-    >>> server = mindsdb_sdk.connect('https://cloud.mindsdb.com', login='a@b.com', password='-')
+    >>> con = mindsdb_sdk.connect(login='a@b.com', password='-')
+    >>> con = mindsdb_sdk.connect('https://cloud.mindsdb.com', login='a@b.com', password='-')
 
     Connect to MindsDB pro
 
-    >>> server = mindsdb_sdk.connect('http://<YOUR_INSTANCE_IP>', login='a@b.com', password='-', is_managed=True)
+    >>> con = mindsdb_sdk.connect('http://<YOUR_INSTANCE_IP>', login='a@b.com', password='-', is_managed=True)
 
     """
     if url is None:

mindsdb_sdk/handlers.py

@@ -9,6 +9,9 @@
 
 @dataclass(init=False)
 class Handler:
+    """
+    :meta private:
+    """
     name: str
     title: str
     version: str
@@ -26,26 +29,7 @@ def __init__(self, **kwargs):
 
 class Handlers(CollectionBase):
     """
-       **Handlers colection**
-
-       Examples of usage:
-
-       ML handlers:
-
-       Get list
-       >>> con.ml_handlers.list()
-
-       Get
-       >>> openai_handler = con.ml_handlers.openai
-
-       DATA handlers:
-
-       Get list
-       >>> con.data_handlers.list()
-
-       Get
-       >>> pg_handler = con.data_handlers.postgres
-
+    :meta private:
     """
 
     def __init__(self, api, type):
@@ -91,3 +75,43 @@ def get(self, name: str) -> Handler:
             if item.name == name:
                 return item
         raise AttributeError(f"Handler doesn't exist: {name}")
+
+
+class MLHandlers(Handlers):
+    """
+       **ML handlers colection**
+
+       Examples of usage:
+
+       Get list
+
+       >>> con.ml_handlers.list()
+
+       Get
+
+       >>> openai_handler = con.ml_handlers.openai
+       >>> openai_handler = con.ml_handlers.get('openai')
+
+    """
+
+    ...
+
+
+class DataHandlers(Handlers):
+    """
+        **DATA handlers colection**
+
+        Examples of usage:
+
+        Get list
+
+        >>> con.data_handlers.list()
+
+        Get
+
+        >>> pg_handler = con.data_handlers.postgres
+        >>> pg_handler = con.data_handlers.get('postgres')
+
+    """
+
+    ...

mindsdb_sdk/jobs.py

@@ -99,7 +99,10 @@ def create(self, name: str, query_str: str,
                    repeat_str: str = None) -> Union[Job, None]:
         """
         Create new job in project and return it.
-        If it is not possible (job executed and not accessible anymore): return None
+
+        If it is not possible (job executed and not accessible anymore):
+           return None
+
         More info: https://docs.mindsdb.com/sql/create/jobs
 
         :param name: name of the job

mindsdb_sdk/ml_engines.py

@@ -10,6 +10,9 @@
 
 @dataclass
 class MLEngine:
+    """
+    :meta private:
+    """
     name: str
     handler: str
     connection_data: dict
@@ -23,19 +26,23 @@ class MLEngines(CollectionBase):
     Examples of usage:
 
     Get list
+
     >>> ml_engines = con.ml_engines.list()
 
     Get
+
     >>> openai_engine = con.ml_engines.openai1
 
     Create
+
     >>> con.ml_engines.create(
     ...    'openai1',
     ...    'openai',
     ...    connection_data={'api_key': '111'}
     ...)
 
     Drop
+
     >>>  con.ml_engines.drop('openai1')
 
     """
@@ -46,6 +53,7 @@ def __init__(self, api):
     def list(self) -> List[MLEngine]:
         """
         Returns list of ml engines on server
+
         :return: list of ml engines
         """
 
@@ -77,6 +85,7 @@ def get(self, name: str) -> MLEngine:
     def create(self, name: str, handler: Union[str, Handler], connection_data: dict = None) -> MLEngine:
         """
         Create new ml engine and return it
+
         :param name: ml engine name, string
         :param handler: handler name, string or Handler
         :param connection_data: parameters for ml engine, dict, optional
@@ -95,6 +104,7 @@ def create(self, name: str, handler: Union[str, Handler], connection_data: dict
     def drop(self, name: str):
         """
         Drop ml engine by name
+
         :param name: name
         """
         ast_query = DropMLEngine(Identifier(name))

mindsdb_sdk/models.py

@@ -117,9 +117,11 @@ def predict(self, data: Union[pd.DataFrame, Query, dict], params: dict = None) -
         """
         Make prediction using model
 
-        if data is dataframe it uses /model/predict http method and sends dataframe over it
-        if data is select query with one table it replaces table to jon table and predictor
-        and sends query over sql/query http method
+        if data is dataframe
+          it uses /model/predict http method and sends dataframe over it
+
+        if data is select query with one table
+         it replaces table to jon table and predictor and sends query over sql/query http method
 
         if data is select from join other complex query it modifies query to:
           'select from (input query) join model' and sends it over sql/query http method
@@ -549,8 +551,10 @@ def list(self, with_versions: bool = False,
         """
         List models (or model versions) in project
 
-        If with_versions = True it shows all models with version (executes 'select * from models_versions')
-        Otherwise it shows only models (executes 'select * from models')
+        If with_versions = True
+          it shows all models with version (executes 'select * from models_versions')
+
+          Otherwise it shows only models (executes 'select * from models')
 
         :param with_versions: show model versions
         :param name: to show models or versions only with selected name, optional

mindsdb_sdk/projects.py

@@ -21,9 +21,9 @@ class Project:
     Server instance allows to manipulate project and databases (integration) on mindsdb server
 
     Attributes for accessing to different objects:
-        - models
-        - views
-        - jobs
+        - models, see :func:`~mindsdb_sdk.models.Models`
+        - views, see :func:`~mindsdb_sdk.views.Views`
+        - jobs, see :func:`~mindsdb_sdk.jobs.Jobs`
 
     It is possible to cal queries from project context:
 
@@ -109,23 +109,23 @@ class Projects(CollectionBase):
     Projects
     ----------
 
-    # list of projects
+    list of projects
 
     >>> projects.list()
 
-    # create
+    create
 
     >>> project = projects.create('proj')
 
-    # drop
+    drop
 
     >>> projects.drop('proj')
 
-    # get existing
+    get existing
 
     >>> projects.get('proj')
 
-    # by attribute
+    by attribute
     >>> projects.proj
 
     """