Skip to content

Commit

Permalink
Update installation instructions for module dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilipMay committed Dec 21, 2023
1 parent b64d0f9 commit 176fd20
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 20 deletions.
5 changes: 3 additions & 2 deletions mltb2/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@

"""Data loading module.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[data]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[data]``
"""

import os
Expand Down
6 changes: 4 additions & 2 deletions mltb2/fasttext.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
"""fastText specific module.
This module is based on `fastText <https://fasttext.cc/docs/en/support.html>`_.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[fasttext]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[fasttext]``
"""

import os
Expand Down
5 changes: 3 additions & 2 deletions mltb2/files.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@

"""File utils module.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[files]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[files]``
"""


Expand Down
5 changes: 3 additions & 2 deletions mltb2/md.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@

"""Markdown specific module.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[md]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[md]``
"""

import re
Expand Down
5 changes: 3 additions & 2 deletions mltb2/openai.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@

"""OpenAI specific module.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[openai]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[openai]``
"""


Expand Down
6 changes: 4 additions & 2 deletions mltb2/optuna.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
"""Optuna specific module.
This module is based on `Optuna <https://optuna.readthedocs.io/en/stable/>`_.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[optuna]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[optuna]``
"""


Expand Down
6 changes: 4 additions & 2 deletions mltb2/plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
"""Plot tools module.
This module is based on `Matplotlib <https://matplotlib.org/>`_.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[plot]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[plot]``
"""

from typing import Optional
Expand Down
6 changes: 4 additions & 2 deletions mltb2/somajo.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
"""SoMaJo specific module.
This module is based on `SoMaJo <https://github.com/tsproisl/SoMaJo>`_.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[somajo]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[somajo]``
"""


Expand Down
6 changes: 4 additions & 2 deletions mltb2/somajo_transformers.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@
This module is based on
`Hugging Face Transformers <https://huggingface.co/docs/transformers/index>`_ and
`SoMaJo <https://github.com/tsproisl/SoMaJo>`_.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[somajo_transformers]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[somajo_transformers]``
"""


Expand Down
6 changes: 4 additions & 2 deletions mltb2/transformers.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
This module is based on
`Hugging Face Transformers <https://huggingface.co/docs/transformers/index>`_.
Use pip to install the necessary dependencies for this module:
``pip install mltb2[transformers]``
Hint:
Use pip to install the necessary dependencies for this module:
``pip install mltb2[transformers]``
"""

import os
Expand Down

0 comments on commit 176fd20

Please sign in to comment.