Skip to content

Commit 747fda3

Browse files
authored
Clarified 0-based indexing requirement for OrderedLogistic and OrderedProbit (#7457)
* Clarified 0-based indexing requirement for OrderedLogistic and OrderedProbit in discrete.rst * Fix end of file issue in discrete.rst
1 parent 8cdc9ee commit 747fda3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/source/api/distributions/discrete.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,8 @@ Discrete
1919
OrderedLogistic
2020
OrderedProbit
2121
Poisson
22+
23+
.. note::
24+
25+
**OrderedLogistic and OrderedProbit:**
26+
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.

0 commit comments

Comments
 (0)