Add objective base classes to API reference (#736)

* init * changelog * add base template test * update problem type docstr * add in property as class docstr for now
alteryx · May 1, 2020 · 185c540 · 185c540
1 parent 61e5a4c
commit 185c540
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 9 deletions.
diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst
@@ -217,6 +217,21 @@ Regressors are models which can be trained to predict a target value from input
 Objective Functions
 ====================
 
+Objective Base Classes
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. autosummary::
+    :toctree: generated
+    :template: class.rst
+    :nosignatures:
+
+    ObjectiveBase
+    BinaryClassificationObjective
+    MulticlassClassificationObjective
+    RegressionObjective
+
+
+
 Domain-Specific Objectives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -11,6 +11,7 @@ Changelog
     * Documentation Changes
         * Add instructions to freeze `master` on `release.md` :pr:`726`
         * Update release instructions with more details :pr:`727` :pr:`733`
+        * Add objective base classes to API reference :pr:`736`
     * Testing Changes
         * Delete codecov yml, use codecov.io's default :pr:`732`
 

diff --git a/evalml/objectives/binary_classification_objective.py b/evalml/objectives/binary_classification_objective.py
@@ -7,12 +7,12 @@
 
 
 class BinaryClassificationObjective(ObjectiveBase):
-    """
-    Base class for all binary classification objectives.
+    """Base class for all binary classification objectives.
 
-    problem_type (ProblemTypes): Specifies the type of problem this objective is defined for (binary classification)
+    problem_type (ProblemTypes): Type of problem this objective is. Set to ProblemTypes.BINARY.
     can_optimize_threshold (bool): Determines if threshold used by objective can be optimized or not.
     """
+
     problem_type = ProblemTypes.BINARY
 
     @property

diff --git a/evalml/objectives/multiclass_classification_objective.py b/evalml/objectives/multiclass_classification_objective.py
@@ -4,9 +4,9 @@
 
 
 class MulticlassClassificationObjective(ObjectiveBase):
-    """
-    Base class for all multiclass classification objectives.
+    """Base class for all multiclass classification objectives.
 
-    problem_type (ProblemTypes): Specifies the type of problem this objective is defined for (multiclass classification).
+    problem_type (ProblemTypes): Type of problem this objective is. Set to ProblemTypes.MULTICLASS.
     """
+
     problem_type = ProblemTypes.MULTICLASS
diff --git a/evalml/objectives/regression_objective.py b/evalml/objectives/regression_objective.py
@@ -4,10 +4,10 @@
 
 
 class RegressionObjective(ObjectiveBase):
-    """
-    Base class for all regression objectives.
+    """Base class for all regression objectives.
 
-    problem_type (ProblemTypes): type of problem this objective is. Set to ProblemTypes.REGRESSION.
+    problem_type (ProblemTypes): Type of problem this objective is. Set to ProblemTypes.REGRESSION.
     """
+
     problem_type = ProblemTypes.REGRESSION
     score_needs_proba = False