statsmodels logit function 1

statsmodels logit function

:orphan:

statsmodels.discrete.discrete\_model.Logit.fit
==============================================

.. currentmodule:: statsmodels.discrete.discrete_model

.. automethod:: Logit.fit
    

Here is what the above code is Doing:
1. The first line is a docstring for the module.
2. The second line is a docstring for the class.
3. The third line is a docstring for the method.

The docstrings are written in reStructuredText, which is a markup language.

The first line of the docstring is a one-line summary of the object’s purpose.
If you have a longer description, you can add a blank line followed by a more
detailed description. These docstrings are processed by a program called
Sphinx, which puts them into HTML and other formats.

The docstrings for the module, class, and method are all indented to the same
level. This is because they are all part of the same “scope”.

The first line of the class and method docstrings are prefixed with an
“automethod” directive. This tells Sphinx to insert the docstring into the
class and method documentation.

The class and method docstrings also have “signature” lines, which show how to
call the class or method. Sphinx gets this information from the Python
interpreter.

The class docstring has a “currentmodule” directive, which tells Sphinx that
the class is defined in the current module.

The method docstring has an “automethod” directive, which tells Sphinx to
insert the docstring into the class documentation.

The method docstring also has an “orphan” directive, which tells Sphinx not to
include the method in the module documentation.

The method docstring also has a “currentmodule” directive, which tells Sphinx
that the method is defined in the current module.

The method docstring also has a “versionadded” directive, which tells Sphinx
that the method was added in a specific version of the package.

The method docstring also has a “versionchanged” directive, which tells Sphinx
that the method was changed in a specific version of the package.

The method docstring also has a “deprecated” directive, which tells Sphinx
that the method is deprecated.

The method docstring also has a “seealso” directive, which tells Sphinx to
include a “See also” section in the documentation.

The method docstring also has a “warning” directive, which tells Sphinx to
include a warning box in the documentation.

The method docstring also has a “note” directive, which tells Sphinx to
include a note box in the documentation.

The method docstring also has a “todo” directive, which tells Sphinx to
include a todo box in the documentation.

The method docstring also has a “bug” directive, which tells Sphinx to
include a bug box in the documentation.

The method docstring also has a “see” directive, which tells Sphinx to
include a “See also” section in the documentation.

The method docstring also has a “ref” directive, which tells Sphinx to
include a reference to another document in the documentation.

The method docstring also has a “cvar” directive, which tells Sphinx to
include a reference to a C variable in the documentation.

The method docstring also has a “ivar” directive, which tells Sphinx to
include a reference to an instance variable in the documentation.

The method docstring also has a “var” directive, which tells Sphinx to
include a reference to a variable in the documentation.

The method docstring also has a “const” directive, which tells Sphinx to
include a reference to a constant in the documentation.

The method docstring also has a “class” directive

Similar Posts