Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
FBruzzesi committed Jun 10, 2024
1 parent 179fe21 commit a2a2c6c
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,29 @@ Scikit-learn smithy is a tool that helps you to forge scikit-learn compatible es

How can you use it?

<details><summary>✅ Directly from the browser via our [web UI](https://sklearn-smithy.streamlit.app/). </summary>
<details><summary>✅ Directly from the browser via a Web UI. </summary>

- Available at [sklearn-smithy.streamlit.app](https://sklearn-smithy.streamlit.app/)
- It requires no installation.
- Powered by [streamlit](https://streamlit.io/)

<img src="https://raw.githubusercontent.com/FBruzzesi/sklearn-smithy/main/docs/img/webui.png" align="right">

</details>

<details><summary>✅ As a CLI (command line interface) in your terminal via the `smith forge` command.</summary>
<details><summary>✅ As a CLI (command line interface) in the terminal.</summary>

- It requires [installation](#installation).
- Available via the `smith forge` command.
- It requires [installation](#installation): `python -m pip install sklearn-smithy`
- Powered by [typer](https://typer.tiangolo.com/).

</details>

<details><summary>✅ As a TUI (terminal user interface) in your terminal via the `smith-tui` command.</summary>
<details><summary>✅ As a TUI (terminal user interface) in the terminal.</summary>

- It requires installing [extra dependencies](#extra-dependencies).
- Powered by [textual](https://textual.textualize.io/), using the `smith-tui` command.
- Available via the `smith-tui` command.
- It requires installing [extra dependencies](#extra-dependencies): `python -m pip install "sklearn-smithy[textual]"`
- Powered by [textual](https://textual.textualize.io/).

<img src="https://raw.githubusercontent.com/FBruzzesi/sklearn-smithy/main/docs/img/tui.png" align="right">

Expand Down

0 comments on commit a2a2c6c

Please sign in to comment.