Skip to content

Commit

Permalink
Fix docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
blythed committed May 22, 2024
1 parent dbd87de commit 04010cf
Show file tree
Hide file tree
Showing 14 changed files with 10 additions and 180 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/ci_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 2 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 0 additions & 21 deletions docs/content/api/backends/ibis/cursor.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/api/base/datalayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|-----------|-------------|
Expand Down
13 changes: 0 additions & 13 deletions docs/content/api/base/enums.md

This file was deleted.

24 changes: 0 additions & 24 deletions docs/content/api/base/logger.md

This file was deleted.

41 changes: 0 additions & 41 deletions docs/content/api/base/serializable.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/content/api/ext/auto.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/api/ext/transformers/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/api/misc/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|-----------|-------------|
Expand Down
14 changes: 0 additions & 14 deletions docs/content/api/misc/colors.md

This file was deleted.

48 changes: 0 additions & 48 deletions docs/content/api/misc/files.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/api/misc/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
6 changes: 3 additions & 3 deletions superduperdb/ext/transformers/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit 04010cf

Please sign in to comment.