Clarified 0-based indexing requirement for OrderedLogistic and Ordere…

…dProbit (#7457) * Clarified 0-based indexing requirement for OrderedLogistic and OrderedProbit in discrete.rst * Fix end of file issue in discrete.rst
pymc-devs · Aug 15, 2024 · 747fda3 · 747fda3
1 parent 8cdc9ee
commit 747fda3
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/source/api/distributions/discrete.rst b/docs/source/api/distributions/discrete.rst
@@ -19,3 +19,8 @@ Discrete
    OrderedLogistic
    OrderedProbit
    Poisson
+
+.. note::
+
+   **OrderedLogistic and OrderedProbit:**
+   The `OrderedLogistic` and `OrderedProbit` distributions expect the observed values to be 0-based, i.e., they should range from `0` to `K-1`. Using 1-based indexing (like `1, 2, 3,...K`) can result in errors.