Skip to content

Commit 157aed6

Browse files
committed
Update installation instructions to include optional editor support
Updated the installation command to specify the optional `[editor]` dependency for users. Added a note emphasizing the core package's dependency-free design for better portability and maintainability. Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
1 parent 44e1279 commit 157aed6

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/source/usage.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ This guide provides a comprehensive walkthrough for utilizing the **ml-orchestra
77

88
Installation
99
------------
10-
To install the package, use `Poetry` with the following command:
10+
1111

1212
.. code-block:: bash
1313
14-
pip install ml-orchestrator
14+
pip install ml-orchestrator[editor]
1515
16-
The **ml-orchestrator** package has no external dependencies by default.
16+
.. note::
17+
The core **ml-orchestrator** package is intentionally designed to be dependency-free. This architectural decision ensures that components created with ml-orchestrator won't have unnecessary liabilities or dependencies, making them more portable and easier to maintain in production environments.
1718

1819
Quick Start
1920
-----------

0 commit comments

Comments
 (0)