Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(installer): update docstrings for install methods

Browse Source
This commit is contained in:
psychedelicious 2024-03-26 14:29:50 +11:00
parent 44626c9452
commit 56af97866e
1 changed files with 13 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
installer/lib/installer.py
View File

@ -122,17 +122,13 @@ class Installer:
find_links: Optional[str] = None, find_links: Optional[str] = None,
wheel: Optional[Path] = None, wheel: Optional[Path] = None,
) -> None: ) -> None:
""" """Install the InvokeAI application into the given runtime path
Install the InvokeAI application into the given runtime path
:param root: Destination path for the installation Args:
:type root: str root: Destination path for the installation
:param version: InvokeAI version to install yes_to_all: Accept defaults to all questions
:type version: str find_links: A local directory to search for requirement wheels before going to remote indexes
:param yes: Accept defaults to all questions wheel: A wheel file to install
:type yes: bool
:param find_links: A local directory to search for requirement wheels before going to remote indexes
:type find_links: str
""" """
import messages import messages
@ -198,17 +194,13 @@ class InvokeAiInstance:
find_links: Optional[str] = None, find_links: Optional[str] = None,
wheel: Optional[Path] = None, wheel: Optional[Path] = None,
): ):
""" """Install the package from PyPi or a wheel, if provided.
Install the package from PyPi.
:param extra_index_url: the "--extra-index-url ..." line for pip to look in extra indexes. Args:
:type extra_index_url: str extra_index_url: the "--extra-index-url ..." line for pip to look in extra indexes.
optional_modules: optional modules to install using "[module1,module2]" format.
:param optional_modules: optional modules to install using "[module1,module2]" format. find_links: path to a directory containing wheels to be searched prior to going to the internet
:type optional_modules: str wheel: a wheel file to install
:param find_links: path to a directory containing wheels to be searched prior to going to the internet
:type find_links: Path
""" """
import messages import messages
@ -246,7 +238,7 @@ class InvokeAiInstance:
find_links, find_links,
"--extra-index-url" if extra_index_url is not None else None, "--extra-index-url" if extra_index_url is not None else None,
extra_index_url, extra_index_url,
pre_flag if not wheel else None, pre_flag if not wheel else None, # Ignore the flag if we are installing a wheel
] ]
try: try: