From 3ca0960be5d2f056d28e6854d51df2b94eac4a0d Mon Sep 17 00:00:00 2001 From: Parag Ekbote Date: Mon, 30 Dec 2024 15:49:36 +0530 Subject: [PATCH] Re-write comments as per review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Clémentine Fourrier <22726840+clefourrier@users.noreply.github.com> --- src/lighteval/models/endpoints/endpoint_model.py | 4 ++-- src/lighteval/models/endpoints/openai_model.py | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/src/lighteval/models/endpoints/endpoint_model.py b/src/lighteval/models/endpoints/endpoint_model.py index 9d3ecbce..4f2e88ab 100644 --- a/src/lighteval/models/endpoints/endpoint_model.py +++ b/src/lighteval/models/endpoints/endpoint_model.py @@ -91,10 +91,10 @@ def from_path(cls, path: str) -> "ServerlessEndpointModelConfig": @dataclass class InferenceEndpointModelConfig: """ - This class is designed to manage and define settings for deploying inference endpoints in machine learning models. +This class defines the settings used to deploy inference endpoints automatically. (Inference endpoint docs: https://huggingface.co/docs/inference-endpoints/index) Attributes: - endpoint_name (str, optional):The name of the inference endpoint. + endpoint_name (str, Optional): Inference endpoint name (to use at creation or reuse) model_name (str, optional): The name of the model for inference. reuse_existing (bool, default: False): Indicates whether to reuse an existing endpoint. accelerator (str, default: "gpu"): Specifies the type of hardware accelerator. diff --git a/src/lighteval/models/endpoints/openai_model.py b/src/lighteval/models/endpoints/openai_model.py index c38e3d2d..d1c9f5f4 100644 --- a/src/lighteval/models/endpoints/openai_model.py +++ b/src/lighteval/models/endpoints/openai_model.py @@ -62,11 +62,10 @@ @dataclass class OpenAIModelConfig: """ - A configuration class for OpenAI models. This class is used to specify settings related to OpenAI models, - including the model name or identifier. - + Configuration class to create an [[OpenAIModel]], to call via its API at inference for evaluation. + Attributes: - model: It specifies the name or identifier of the OpenAI model to be used. + model: name or identifier of the OpenAI model to be used for inference. """ model: str