Closes UNB-2035, UNB-2014, and fixed autosummary vs. numpydoc method generation. Changed enums to classes and created separate pages for model types and task types

Author: whoseoyster

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 * Prevents dataset upload when `label_column_name` is also in `feature_names`.
 * Unbox server URL (<https://api.unbox.ai/>).
+* Parameter ordering for `add_model`, `add_dataset`, `add_dataframe` for clarity's sake.
 
 ### Fixed
 

docs/_templates/class.rst

@@ -4,15 +4,14 @@
 {% if methods %}
 
 ..
-HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the
-pages.
-.. autosummary::
-:toctree:
-{% for item in all_methods %}
-{%- if not item.startswith('_') or item in ['__call__'] %}
-{{ name }}.{{ item }}
-{%- endif -%}
-{%- endfor %}
+   HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
+   .. autosummary::
+      :toctree:
+      {% for item in all_methods %}
+      {%- if not item.startswith('_') or item in ['__call__'] %}
+      {{ name }}.{{ item }}
+      {%- endif -%}
+      {%- endfor %}
 
 {% endif %}
 {% endblock %}
@@ -21,15 +20,14 @@ pages.
 {% if attributes %}
 
 ..
-HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the
-pages.
-.. autosummary::
-:toctree:
-{% for item in all_attributes %}
-{%- if not item.startswith('_') %}
-{{ name }}.{{ item }}
-{%- endif -%}
-{%- endfor %}
+   HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
+   .. autosummary::
+      :toctree:
+      {% for item in all_attributes %}
+      {%- if not item.startswith('_') %}
+      {{ name }}.{{ item }}
+      {%- endif -%}
+      {%- endfor %}
 
 {% endif %}
-{% endblock %}
+{% endblock %}

docs/source/_static/css/logo.css

@@ -0,0 +1,4 @@
+/* Need to resize the logo here somehow */
+a .navbar-brand {
+    height: 100px;
+}

docs/source/conf.py

@@ -134,7 +134,7 @@
 
 # Automatically extract typehints when specified and place them in
 # descriptions of the relevant function/method.
-# autosummary_generate = True
+# autosummary_generate = False
 autodoc_typehints = "none"
 
 # -- Options for HTMLHelp output ---------------------------------------------
@@ -225,4 +225,4 @@
 epub_exclude_files = ["search.html"]
 
 
-# -- Extension configuration -------------------------------------------------
+# -- Extension configuration -------------------------------------------------

docs/source/reference/upload.rst

@@ -9,31 +9,53 @@ Client constructor
 ------------------
 .. autosummary:: 
    :toctree: api/
+   :template: class.rst
 
    UnboxClient
 
 Upload functions
 ----------------
 .. autosummary:: 
    :toctree: api/
+   :template: class.rst
 
    UnboxClient.add_model   
    UnboxClient.add_dataset
    UnboxClient.add_dataframe
 
 
-Types
------
+Model types
+-----------
 .. autosummary:: 
    :toctree: api/
+   :template: class.rst
 
-   TaskType
    ModelType
+   ModelType.fasttext
+   ModelType.sklearn
+   ModelType.pytorch
+   ModelType.tensorflow
+   ModelType.transformers
+   ModelType.keras
+   ModelType.rasa
+   ModelType.custom
+
+Task types
+-----------
+.. autosummary:: 
+   :toctree: api/
+   :template: class.rst
+   
+   TaskType
+   TaskType.TextClassification
+   TaskType.TabularClassification
+   TaskType.TabularRegression
 
 Objects
 -------
 .. autosummary:: 
    :toctree: api/
+   :template: class.rst
 
    Model
    Dataset

setup.py

@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
 
 import pathlib
+from distutils.util import convert_path
 
 import pkg_resources
 from setuptools import find_packages, setup
-from distutils.util import convert_path
 
 with pathlib.Path("requirements.txt").open() as requirements_txt:
     install_requires = [
@@ -13,13 +13,13 @@
     ]
 
 main_ns = {}
-ver_path = convert_path('unboxapi/version.py')
+ver_path = convert_path("unboxapi/version.py")
 with open(ver_path) as ver_file:
     exec(ver_file.read(), main_ns)
 
 setup(
     name="unboxapi",
-    version=main_ns['__version__'],
+    version=main_ns["__version__"],
     description="The official Python client library for Unbox, the Testing and Debugging Platform for AI",
     url="https://github.com/unboxai/unboxapi-python-client",
     author="Unbox",