Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note to repo API on being experimental #336

Merged
merged 1 commit into from
Oct 2, 2023
Merged

Add note to repo API on being experimental #336

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/source/repositories.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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):
Expand Down