mirror/OpenLLM
1
0
Fork 0
mirror of https://github.com/bentoml/OpenLLM.git synced 2026-03-11 11:39:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): update README.md

Browse Source 
See #12
This commit is contained in:
Chaoyu
2023-06-09 17:13:14 -07:00
committed by Aaron
parent 1597d5d4bb
commit e2b26adf2f
6 changed files with 106 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
tools/update-readme.py
View File

@@ -38,11 +38,11 @@ def main() -> int:
readme = f.readlines()
start_index, stop_index = readme.index(START_COMMENT), readme.index(END_COMMENT)
formatted: dict[t.Literal["Model", "CPU", "GPU", "Optional"], list[str]] = {
formatted: dict[t.Literal["Model", "CPU", "GPU", "Installation"], list[str]] = {
"Model": [],
"CPU": [],
"GPU": [],
"Optional": [],
"Installation": [],
}
max_name_len_div = 0
max_install_len_div = 0
@@ -55,19 +55,19 @@ def main() -> int:
formatted["Model"].append(model_name)
formatted["GPU"].append("✅")
formatted["CPU"].append("✅" if not config.__openllm_requires_gpu__ else "❌")
instruction = "👾 (not needed)"
instruction = "`pip install openllm`"
if dashed in deps:
instruction = f"`pip install openllm[{dashed}]`"
instruction = f"""`pip install "openllm[{dashed}]"`"""
else:
does_not_need_custom_installation.append(model_name)
if len(instruction) > max_install_len_div:
max_install_len_div = len(instruction)
formatted["Optional"].append(instruction)
formatted["Installation"].append(instruction)
meta = ["\n"]
# NOTE: headers
meta += f"| Model {' ' * (max_name_len_div - 6)} | CPU | GPU | Optional {' ' * (max_install_len_div - 8)}|\n"
meta += f"| Model {' ' * (max_name_len_div - 6)} | CPU | GPU | Installation {' ' * (max_install_len_div - 8)}|\n"
# NOTE: divs
meta += f"| {'-' * max_name_len_div}" + " | --- | --- | " + f"{'-' * max_install_len_div} |\n"
# NOTE: rows
@@ -88,15 +88,6 @@ def main() -> int:
)
meta += "\n"
# NOTE: adding notes
meta += """\
> NOTE: We respect users' system disk space. Hence, OpenLLM doesn't enforce to
> install dependencies to run all models. If one wishes to use any of the
> aforementioned models, make sure to install the optional dependencies
> mentioned above.
"""
readme = readme[:start_index] + [START_COMMENT] + meta + [END_COMMENT] + readme[stop_index + 1 :]
with open(os.path.join(ROOT, "README.md"), "w") as f: