docs: add warning about generated readmes

This commit is contained in:
Jun Siang Cheah committed 2024-11-14 22:24:13 +00:00
1 parent 6872de4af2
commit d85e2593d8
2 files changed
+8 -1

No files matched your search

+3
View File
@@ -1,3 +1,6 @@
<!---
WARNING: DO NOT EDIT THIS FILE DIRECTLY. IT IS GENERATED BY src/pull_available_models.py
--->
# Free LLM API resources
This lists various services that provide free access or credits towards API-based LLM usage.
+5 -1
View File
@@ -820,8 +820,12 @@ def main():
script_dir = os.path.dirname(os.path.abspath(__file__))
with open(os.path.join(script_dir, "README_template.md"), "r") as f:
readme = f.read()
warning = """<!---
WARNING: DO NOT EDIT THIS FILE DIRECTLY. IT IS GENERATED BY src/pull_available_models.py
--->
"""
with open(os.path.join(script_dir, "..", "README.md"), "w") as f:
f.write(readme.replace("{{MODEL_LIST}}", table).replace("{{TRIAL_MODEL_LIST}}", trial_table))
f.write((warning + readme).replace("{{MODEL_LIST}}", table).replace("{{TRIAL_MODEL_LIST}}", trial_table))
logger.info("Wrote models to README.md")