Skip to content

Commit

Permalink
Fix more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kwinkunks committed Sep 28, 2023
1 parent 0c1a1b6 commit f7f3ed6
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,24 @@ Quick start
.. toctree::
:caption: Quick start

Install ``redflag`` with pip:
Install ``redflag`` with pip or with ``conda`` from the ``conda-forge`` channel:

.. code-block:: shell
pip install redflag
Import ``redflag`` in your Python program:

.. code-block:: python
import redflag as rf
There are three main ways to use ``redflag``:

1. ``scikit-learn`` components for your pipelines, e.g. ``rf.ImbalanceDetector().fit_transform(X, y)``.
2. ``pandas`` accessors on Series and DataFrames, e.g. ``df['target'].redflag.imbalance_degree()``.
3. As a library of standalone functions, e.g. ``rf.imbalance_degree(y)``.

Carry on exploring with the user guide below.


Expand Down

0 comments on commit f7f3ed6

Please sign in to comment.