feat: add deprecation warning to clients (#1855)

This PR adds a deprecation warning to the clients and points users to
the https://github.com/huggingface/huggingface_hub
This commit is contained in:
drbh 2024-05-15 09:40:07 -04:00 committed by GitHub
parent a70b087e71
commit a69ef52cf6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 0 deletions

View File

@ -14,5 +14,10 @@
__version__ = "0.6.0" __version__ = "0.6.0"
DEPRECATION_WARNING = (
"`text_generation` clients are deprecated and will be removed in the near future. "
"Please use the `InferenceClient` from the `huggingface_hub` package instead."
)
from text_generation.client import Client, AsyncClient from text_generation.client import Client, AsyncClient
from text_generation.inference_api import InferenceAPIClient, InferenceAPIAsyncClient from text_generation.inference_api import InferenceAPIClient, InferenceAPIAsyncClient

View File

@ -1,10 +1,12 @@
import json import json
import requests import requests
import warnings
from aiohttp import ClientSession, ClientTimeout from aiohttp import ClientSession, ClientTimeout
from pydantic import ValidationError from pydantic import ValidationError
from typing import Dict, Optional, List, AsyncIterator, Iterator, Union from typing import Dict, Optional, List, AsyncIterator, Iterator, Union
from text_generation import DEPRECATION_WARNING
from text_generation.types import ( from text_generation.types import (
StreamResponse, StreamResponse,
Response, Response,
@ -19,6 +21,9 @@ from text_generation.types import (
) )
from text_generation.errors import parse_error from text_generation.errors import parse_error
# emit deprecation warnings
warnings.simplefilter("always", DeprecationWarning)
class Client: class Client:
"""Client to make calls to a text-generation-inference instance """Client to make calls to a text-generation-inference instance
@ -59,6 +64,7 @@ class Client:
timeout (`int`): timeout (`int`):
Timeout in seconds Timeout in seconds
""" """
warnings.warn(DEPRECATION_WARNING, DeprecationWarning)
self.base_url = base_url self.base_url = base_url
self.headers = headers self.headers = headers
self.cookies = cookies self.cookies = cookies
@ -449,6 +455,7 @@ class AsyncClient:
timeout (`int`): timeout (`int`):
Timeout in seconds Timeout in seconds
""" """
warnings.warn(DEPRECATION_WARNING, DeprecationWarning)
self.base_url = base_url self.base_url = base_url
self.headers = headers self.headers = headers
self.cookies = cookies self.cookies = cookies