Skip to content

Commit f3d5498

Browse files
committed
docs: contributing guide - new models note
1 parent e2a6417 commit f3d5498

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/contributing.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,14 @@ All documentation files should use **kebab-case** (e.g., `model-hub.md`, `foreca
7777

7878
For further reference, see the [Google Developer Documentation Style Guide on file names](https://developers.google.com/style/filenames).
7979

80+
### Adding Models & Adapters
81+
82+
In order for new models and adapters to show up in TimeCopilot's documentation properly there are a couple steps to take:
83+
84+
- Add the model/adapter in its own file or the appropriate file in `docs/api/models` or the appropriate subdirectory. For adapters, it may also be good to create an example notebook in `docs/examples` and add it to the `Examples` section of [mkdocs.yml](https://github.com/TimeCopilot/timecopilot/blob/main/mkdocs.yml).
85+
- when creating a new file in `docs/api/models` for this step, add that file in the API Reference section of [mkdocs.yml](https://github.com/TimeCopilot/timecopilot/blob/main/mkdocs.yml)
86+
- A docstring should be present for the new model/adapter with an example in the `forecast()` method in a similar style to the [TimeCopilot agent query method](https://timecopilot.dev/api/agent/#timecopilot.agent.TimeCopilot.query). Note: when adding an adapter with its own dependencies you may need to add those dependencies as dev dependencies with `uv add new_dep --group dev`.
87+
8088
## Adding New Datasets
8189

8290
The datasets utilized in our documentation are hosted on AWS at `https://timecopilot.s3.amazonaws.com/public/data/`. If you wish to contribute additional datasets for your changes, please contact [@AzulGarza](http://github.com/AzulGarza) for guidance.
@@ -115,4 +123,4 @@ TimeCopilot uses some forked Python packages, maintained under custom names on P
115123
- **uni2ts**:
116124
- Forked from: [SalesforceAIResearch/uni2ts](https://github.com/SalesforceAIResearch/uni2ts)
117125
- TimeCopilot fork: [AzulGarza/uni2ts](https://github.com/AzulGarza/uni2ts)
118-
- Published on PyPI as: [`timecopilot-uni2ts`](https://pypi.org/project/timecopilot-uni2ts/)
126+
- Published on PyPI as: [`timecopilot-uni2ts`](https://pypi.org/project/timecopilot-uni2ts/)

0 commit comments

Comments
 (0)