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.

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

Fix library top-level imports #1296

Merged
merged 5 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion docs/reference/models/llamacpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ Outlines provides an integration with [Llama.cpp](https://github.com/ggerganov/l

!!! Note "Installation"

You need to install the `llama-cpp-python` library to use the llama.cpp integration. See the [installation section](#installation) for instructions to install `llama-cpp-python` with CUDA, Metal, ROCm and other backends.
You need to install the `llama-cpp-python` library to use the llama.cpp integration. See the [installation section](#installation) for instructions to install `llama-cpp-python` with CUDA, Metal, ROCm and other backends. To get started quickly you can also run:

```bash
pip install "outlines[llamacpp]"
```

## Load the model

Expand Down
6 changes: 5 additions & 1 deletion docs/reference/models/mlxlm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ Outlines provides an integration with [mlx-lm](https://github.com/ml-explore/mlx

!!! Note "Installation"

You need to install the `mlx` and `mlx-lm` libraries on a device which [supports Metal](https://support.apple.com/en-us/102894) to use the mlx-lm integration.
You need to install the `mlx` and `mlx-lm` libraries on a device which [supports Metal](https://support.apple.com/en-us/102894) to use the mlx-lm integration. To get started quickly you can also run:

```bash
pip install "outlines[mlxlm]"
```


## Load the model
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/models/openai.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

!!! Installation

You need to install the `openai` library to be able to use the OpenAI API in Outlines.
You need to install the `openai` library to be able to use the OpenAI API in Outlines. Or alternatively:

```bash
pip install "outlines[openai]"
```

## OpenAI models

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/models/transformers.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

!!! Installation

You need to install the `transformer`, `datasets` and `torch` libraries to be able to use these models in Outlines:
You need to install the `transformer`, `datasets` and `torch` libraries to be able to use these models in Outlines, or alternatively:

```bash
pip install torch transformers datasets
pip install "outlines[transformers]"
```


Expand Down
6 changes: 5 additions & 1 deletion docs/reference/models/vllm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@

!!! Note "Installation"

You need to install the `vllm` library to use the vLLM integration. See the [installation section](#installation) for instructions to install vLLM for CPU or ROCm.
You need to install the `vllm` library to use the vLLM integration. See the [installation section](#installation) for instructions to install vLLM for CPU or ROCm. To get started you can also run:

```bash
pip install "outlines[vllm]"
```

## Load the model

Expand Down
4 changes: 2 additions & 2 deletions outlines/models/transformers.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
import inspect
from typing import TYPE_CHECKING, Iterator, List, Optional, Tuple, Union

from datasets.fingerprint import Hasher

from outlines.generate.api import GenerationParameters, SamplingParameters
from outlines.models.tokenizer import Tokenizer

Expand Down Expand Up @@ -116,6 +114,8 @@ def __eq__(self, other):
return NotImplemented

def __hash__(self):
from datasets.fingerprint import Hasher

return hash(Hasher.hash(self.tokenizer))

def __getstate__(self):
Expand Down
7 changes: 4 additions & 3 deletions outlines/models/vllm.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import dataclasses
from typing import TYPE_CHECKING, List, Optional, Union

from transformers import SPIECE_UNDERLINE, PreTrainedTokenizerBase

from outlines.generate.api import GenerationParameters, SamplingParameters

if TYPE_CHECKING:
from transformers import PreTrainedTokenizerBase
from vllm import LLM
from vllm.sampling_params import SamplingParams

Expand Down Expand Up @@ -188,7 +187,7 @@ def vllm(model_name: str, **vllm_model_params):
return VLLM(model)


def adapt_tokenizer(tokenizer: PreTrainedTokenizerBase) -> PreTrainedTokenizerBase:
def adapt_tokenizer(tokenizer: "PreTrainedTokenizerBase") -> "PreTrainedTokenizerBase":
"""Adapt a tokenizer to use to compile the FSM.

The API of Outlines tokenizers is slightly different to that of `transformers`. In
Expand All @@ -205,6 +204,8 @@ def adapt_tokenizer(tokenizer: PreTrainedTokenizerBase) -> PreTrainedTokenizerBa
PreTrainedTokenizerBase
The adapted tokenizer.
"""
from transformers import SPIECE_UNDERLINE

tokenizer.vocabulary = tokenizer.get_vocab()
tokenizer.special_tokens = set(tokenizer.all_special_tokens)

Expand Down
9 changes: 8 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ dependencies = [
"jsonschema",
"requests",
"tqdm",
"datasets",
"typing_extensions",
"pycountry",
"airportsdata",
Expand All @@ -46,6 +45,12 @@ dependencies = [
dynamic = ["version"]

[project.optional-dependencies]
vllm = ["vllm", "transformers", "numpy2"]
transformers = ["transformers", "accelerate", "datasets", "numpy<2"]
mlxlm = ["mlx-lm", "datasets"]
openai = ["openai"]
llamacpp = ["llama-cpp-python", "transformers", "datasets", "numpy<2"]
exllamav2 = ["exllamav2"]
test = [
"pre-commit",
"pytest",
Expand All @@ -61,10 +66,12 @@ test = [
"mlx-lm>=0.19.2; platform_machine == 'arm64' and sys_platform == 'darwin'",
"huggingface_hub",
"openai>=1.0.0",
"datasets",
"vllm; sys_platform != 'darwin'",
"transformers",
"pillow",
"exllamav2",
"jax"
]
serve = [
"vllm>=0.3.0",
Expand Down
2 changes: 1 addition & 1 deletion tests/generate/test_integration_transformers_vision.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def img_from_url(url):
@pytest.fixture(scope="session")
def model(tmp_path_factory):
return transformers_vision(
"trl-internal-testing/tiny-random-LlavaForConditionalGeneration",
"trl-internal-testing/tiny-LlavaForConditionalGeneration",
model_class=LlavaForConditionalGeneration,
device="cpu",
)
Expand Down
Loading