From 66fff38e78858e8c916a628e5ea6fdbdba3eef88 Mon Sep 17 00:00:00 2001 From: Madeesh Kannan Date: Mon, 2 Oct 2023 13:05:04 +0200 Subject: [PATCH] Add note to repo API on being experimental (#336) --- docs/source/repositories.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/repositories.rst b/docs/source/repositories.rst index 83290c4d..1d23d2e0 100644 --- a/docs/source/repositories.rst +++ b/docs/source/repositories.rst @@ -1,9 +1,12 @@ Repositories ============ +.. important:: + This API is currently experimental and can change between minor releases. + Models and tokenizers can be loaded from repositories using the ``from_repo`` method. You can add your own type of repository by implementing the -:py:class:`curated_transformers.repository.Repository` base class. +:py:class:`~curated_transformers.repository.Repository` base class. This is an example repository that opens files on the local filesystem: @@ -12,7 +15,7 @@ This is an example repository that opens files on the local filesystem: import os.path from typing import Optional - from curated_transformers.repository import Repository, RepositoryFile + from curated_transformers.repository import Repository, RepositoryFile, LocalFile class LocalRepository(Repository): def __init__(self, path: str):