Add note to repo API on being experimental

explosion · Oct 2, 2023 · f8404fc · f8404fc
1 parent 1f023dc
commit f8404fc
Showing 1 changed file with 5 additions and 2 deletions.
diff --git 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):