Fix docs build

SuperDuperDB · May 22, 2024 · 04010cf · 04010cf
1 parent dbd87de
commit 04010cf
Show file tree

Hide file tree

Showing 14 changed files with 10 additions and 180 deletions.
diff --git a/.github/workflows/ci_docs.yaml b/.github/workflows/ci_docs.yaml
@@ -56,6 +56,5 @@ jobs:
         if: github.ref == 'refs/heads/main'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/hr/build
+          publish_dir: docs/build
           cname: docs.superduperdb.com
-          enable_jekyll: true
diff --git a/Makefile b/Makefile
@@ -62,13 +62,9 @@ install_devkit: ## Add essential development tools
 ##@ Code Quality
 
 gen_docs: ## Generate Docs and API
-	@echo "===> Generate API docs as Markdown <==="
-	python docs/hr/content/build_api_docs.py
-	@echo "Build finished. The HTML pages are in docs/hr/content/build_api_docs"
-
 	@echo "===> Generate docusaurus docs and blog-posts <==="
-	cd docs/hr && npm i --legacy-peer-deps && npm run build
-	cd ../..
+	cd docs && npm i --legacy-peer-deps && npm run build
+	cd ..
 	@echo "Build finished. The HTML pages are in docs/hr/build"
 
 lint-and-type-check: ## Lint and type-check the code

diff --git a/docs/content/api/backends/ibis/cursor.md b/docs/content/api/backends/ibis/cursor.md
diff --git a/docs/content/api/base/datalayer.md b/docs/content/api/base/datalayer.md
@@ -9,7 +9,7 @@ Datalayer(self,
      databackend: superduperdb.backends.base.data_backend.BaseDataBackend,
      metadata: superduperdb.backends.base.metadata.MetaDataStore,
      artifact_store: superduperdb.backends.base.artifacts.ArtifactStore,
-     compute: superduperdb.backends.base.compute.ComputeBackend = <superduperdb.backends.local.compute.LocalComputeBackend object at 0x12d58cd50>)
+     compute: superduperdb.backends.base.compute.ComputeBackend = <superduperdb.backends.local.compute.LocalComputeBackend object at 0x1459d8790>)
 ```
 | Parameter | Description |
 |-----------|-------------|

diff --git a/docs/content/api/base/enums.md b/docs/content/api/base/enums.md
diff --git a/docs/content/api/base/logger.md b/docs/content/api/base/logger.md
diff --git a/docs/content/api/base/serializable.md b/docs/content/api/base/serializable.md
diff --git a/docs/content/api/ext/auto.md b/docs/content/api/ext/auto.md
diff --git a/docs/content/api/ext/transformers/model.md b/docs/content/api/ext/transformers/model.md
@@ -53,7 +53,7 @@ LLM(self,
 | adapter_id | adapter id, default is None Add a adapter to the base model for inference. |
 | model_kwargs | model kwargs, all the kwargs will pass to `transformers.AutoModelForCausalLM.from_pretrained` |
 | tokenizer_kwargs | tokenizer kwargs, all the kwargs will pass to `transformers.AutoTokenizer.from_pretrained` |
-| prompt_template | prompt template, default is "{input}" |
+| prompt_template | prompt template, default is `"{input}"` |
 
 LLM model based on `transformers` library.
 

diff --git a/docs/content/api/misc/annotations.md b/docs/content/api/misc/annotations.md
@@ -33,7 +33,7 @@ This will result in a warning being emitted when the function is used.
 
 ```python
 component(*schema: Dict,
-     handle_integration: Callable = <function <lambda> at 0x104aa3c40>)
+     handle_integration: Callable = <function <lambda> at 0x10694fc40>)
 ```
 | Parameter | Description |
 |-----------|-------------|

diff --git a/docs/content/api/misc/colors.md b/docs/content/api/misc/colors.md
diff --git a/docs/content/api/misc/files.md b/docs/content/api/misc/files.md
diff --git a/docs/content/api/misc/serialization.md b/docs/content/api/misc/serialization.md
@@ -7,7 +7,7 @@
 ```python
 asdict(obj,
      *,
-     copy_method=<function copy at 0x1010b1f80>) -> Dict[str,
+     copy_method=<function copy at 0x102f61f80>) -> Dict[str,
      Any]
 ```
 | Parameter | Description |

diff --git a/superduperdb/ext/transformers/model.py b/superduperdb/ext/transformers/model.py
@@ -249,7 +249,7 @@ class LLM(BaseLLM, _Fittable):
         all the kwargs will pass to `transformers.AutoModelForCausalLM.from_pretrained`
     :param tokenizer_kwargs: tokenizer kwargs,
         all the kwargs will pass to `transformers.AutoTokenizer.from_pretrained`
-    :param prompt_template: prompt template, default is "{input}"
+    :param prompt_template: prompt template, default is `"{input}"`
     :param prompt_func: prompt function, default is None
 
     All the `model_kwargs` will pass to
@@ -298,11 +298,11 @@ def from_pretrained(
         """A new function to create a LLM model from from_pretrained function.
 
         Allow the user to directly replace:
-        AutoModelForCausalLM.from_pretrained -> LLM.from_pretrained
+        `AutoModelForCausalLM.from_pretrained` -> `LLM.from_pretrained`
 
         :param model_name_or_path: model name or path
         :param identifier: model identifier
-        :param prompt_template: prompt template, default is "{input}"
+        :param prompt_template: prompt template, default is `"{input}"`
         :param prompt_func: prompt function, default is None
         :param predict_kwargs: predict kwargs, default is None
         :param kwargs: additional keyword arguments, all the kwargs will pass to `LLM`