Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/ray-project/llmperf

LLMPerf is a library for validating and benchmarking LLMs
https://github.com/ray-project/llmperf
Last synced: 3 months ago
JSON representation
LLMPerf is a library for validating and benchmarking LLMs
Host: GitHub
URL: https://github.com/ray-project/llmperf
Owner: ray-project
License: apache-2.0
Created: 2023-10-10T16:49:58.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-06-19T05:26:46.000Z (5 months ago)
Last Synced: 2024-06-19T13:00:19.746Z (5 months ago)
Language: Python
Homepage:
Size: 220 KB
Stars: 452
Watchers: 9
Forks: 66
Open Issues: 29
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project

awesome-llm-eval - llmperf - 11-03）| (Datasets-or-Benchmark / 推理速度)
awesome-llm-projects - LLMPerf - project/llmperf-leaderboard) for LLMs. (Projects / 📋 Others)
awesome-production-machine-learning - LLMPerf - project/llmperf.svg?style=social) - LLMPerf is a tool for evaluating the performance of LLM APIs. (Evaluation and Monitoring)
README

        # LLMPerf

A Tool for evaulation the performance of LLM APIs.

# Installation

```bash

git clone https://github.com/ray-project/llmperf.git

cd llmperf

pip install -e .

```

# Basic Usage

We implement 2 tests for evaluating LLMs: a load test to check for performance and a correctness test to check for correctness.

## Load test

The load test spawns a number of concurrent requests to the LLM API and measures the inter-token latency and generation throughput per request and across concurrent requests. The prompt that is sent with each request is of the format:

```

Randomly stream lines from the following text. Don't generate eos tokens:

LINE 1,

LINE 2,

LINE 3,

...

```

Where the lines are randomly sampled from a collection of lines from Shakespeare sonnets. Tokens are counted using the `LlamaTokenizer` regardless of which LLM API is being tested. This is to ensure that the prompts are consistent across different LLM APIs.

To run the most basic load test you can the token_benchmark_ray script.

### Caveats and Disclaimers

- The endpoints provider backend might vary widely, so this is not a reflection on how the software runs on a particular hardware.

- The results may vary with time of day.

- The results may vary with the load.

- The results may not correlate with users’ workloads.

### OpenAI Compatible APIs

```bash

export OPENAI_API_KEY=secret_abcdefg

export OPENAI_API_BASE="https://api.endpoints.anyscale.com/v1"

python token_benchmark_ray.py \

--model "meta-llama/Llama-2-7b-chat-hf" \

--mean-input-tokens 550 \

--stddev-input-tokens 150 \

--mean-output-tokens 150 \

--stddev-output-tokens 10 \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

--llm-api openai \

--additional-sampling-params '{}'

```

### Anthropic

```bash

export ANTHROPIC_API_KEY=secret_abcdefg

python token_benchmark_ray.py \

--model "claude-2" \

--mean-input-tokens 550 \

--stddev-input-tokens 150 \

--mean-output-tokens 150 \

--stddev-output-tokens 10 \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

--llm-api anthropic \

--additional-sampling-params '{}'

```

### TogetherAI

```bash

export TOGETHERAI_API_KEY="YOUR_TOGETHER_KEY"

python token_benchmark_ray.py \

--model "together_ai/togethercomputer/CodeLlama-7b-Instruct" \

--mean-input-tokens 550 \

--stddev-input-tokens 150 \

--mean-output-tokens 150 \

--stddev-output-tokens 10 \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

--llm-api "litellm" \

--additional-sampling-params '{}'

```

### Hugging Face

```bash

export HUGGINGFACE_API_KEY="YOUR_HUGGINGFACE_API_KEY"

export HUGGINGFACE_API_BASE="YOUR_HUGGINGFACE_API_ENDPOINT"

python token_benchmark_ray.py \

--model "huggingface/meta-llama/Llama-2-7b-chat-hf" \

--mean-input-tokens 550 \

--stddev-input-tokens 150 \

--mean-output-tokens 150 \

--stddev-output-tokens 10 \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

--llm-api "litellm" \

--additional-sampling-params '{}'

```

### LiteLLM

LLMPerf can use LiteLLM to send prompts to LLM APIs. To see the environment variables to set for the provider and arguments that one should set for model and additional-sampling-params.

see the [LiteLLM Provider Documentation](https://docs.litellm.ai/docs/providers).

```bash

python token_benchmark_ray.py \

--model "meta-llama/Llama-2-7b-chat-hf" \

--mean-input-tokens 550 \

--stddev-input-tokens 150 \

--mean-output-tokens 150 \

--stddev-output-tokens 10 \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

--llm-api "litellm" \

--additional-sampling-params '{}'

```

### Vertex AI

Here, --model is used for logging, not for selecting the model. The model is specified in the Vertex AI Endpoint ID.

The GCLOUD_ACCESS_TOKEN needs to be somewhat regularly set, as the token generated by `gcloud auth print-access-token` expires after 15 minutes or so.

Vertex AI doesn't return the total number of tokens that are generated by their endpoint, so tokens are counted using the LLama tokenizer.

```bash

gcloud auth application-default login

gcloud config set project YOUR_PROJECT_ID

export GCLOUD_ACCESS_TOKEN=$(gcloud auth print-access-token)

export GCLOUD_PROJECT_ID=YOUR_PROJECT_ID

export GCLOUD_REGION=YOUR_REGION

export VERTEXAI_ENDPOINT_ID=YOUR_ENDPOINT_ID

python token_benchmark_ray.py \

--model "meta-llama/Llama-2-7b-chat-hf" \

--mean-input-tokens 550 \

--stddev-input-tokens 150 \

--mean-output-tokens 150 \

--stddev-output-tokens 10 \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

--llm-api "vertexai" \

--additional-sampling-params '{}'

```

### SageMaker

SageMaker doesn't return the total number of tokens that are generated by their endpoint, so tokens are counted using the LLama tokenizer.

```bash

export AWS_ACCESS_KEY_ID="YOUR_ACCESS_KEY_ID"

export AWS_SECRET_ACCESS_KEY="YOUR_SECRET_ACCESS_KEY"s

export AWS_SESSION_TOKEN="YOUR_SESSION_TOKEN"

export AWS_REGION_NAME="YOUR_ENDPOINTS_REGION_NAME"

python llm_correctness.py \

--model "llama-2-7b" \

--llm-api "sagemaker" \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

```

see `python token_benchmark_ray.py --help` for more details on the arguments.

## Correctness Test

The correctness test spawns a number of concurrent requests to the LLM API with the following format:

```

Convert the following sequence of words into a number: {random_number_in_word_format}. Output just your final answer.

```

where random_number_in_word_format could be for example "one hundred and twenty three". The test then checks that the response contains that number in digit format which in this case would be 123.

The test does this for a number of randomly generated numbers and reports the number of responses that contain a mismatch.

To run the most basic correctness test you can run the the llm_correctness.py script.

### OpenAI Compatible APIs

```bash

export OPENAI_API_KEY=secret_abcdefg

export OPENAI_API_BASE=https://console.endpoints.anyscale.com/m/v1

python llm_correctness.py \

--model "meta-llama/Llama-2-7b-chat-hf" \

--max-num-completed-requests 150 \

--timeout 600 \

--num-concurrent-requests 10 \

--results-dir "result_outputs"

```

### Anthropic

```bash

export ANTHROPIC_API_KEY=secret_abcdefg

python llm_correctness.py \

--model "claude-2" \

--llm-api "anthropic"  \

--max-num-completed-requests 5 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs"

```

### TogetherAI

```bash

export TOGETHERAI_API_KEY="YOUR_TOGETHER_KEY"

python llm_correctness.py \

--model "together_ai/togethercomputer/CodeLlama-7b-Instruct" \

--llm-api "litellm" \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

```

### Hugging Face

```bash

export HUGGINGFACE_API_KEY="YOUR_HUGGINGFACE_API_KEY"

export HUGGINGFACE_API_BASE="YOUR_HUGGINGFACE_API_ENDPOINT"

python llm_correctness.py \

--model "huggingface/meta-llama/Llama-2-7b-chat-hf" \

--llm-api "litellm" \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

```

### LiteLLM

LLMPerf can use LiteLLM to send prompts to LLM APIs. To see the environment variables to set for the provider and arguments that one should set for model and additional-sampling-params.

see the [LiteLLM Provider Documentation](https://docs.litellm.ai/docs/providers).

```bash

python llm_correctness.py \

--model "meta-llama/Llama-2-7b-chat-hf" \

--llm-api "litellm" \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

```

see `python llm_correctness.py --help` for more details on the arguments.

### Vertex AI

Here, --model is used for logging, not for selecting the model. The model is specified in the Vertex AI Endpoint ID.

The GCLOUD_ACCESS_TOKEN needs to be somewhat regularly set, as the token generated by `gcloud auth print-access-token` expires after 15 minutes or so.

Vertex AI doesn't return the total number of tokens that are generated by their endpoint, so tokens are counted using the LLama tokenizer.

```bash

gcloud auth application-default login

gcloud config set project YOUR_PROJECT_ID

export GCLOUD_ACCESS_TOKEN=$(gcloud auth print-access-token)

export GCLOUD_PROJECT_ID=YOUR_PROJECT_ID

export GCLOUD_REGION=YOUR_REGION

export VERTEXAI_ENDPOINT_ID=YOUR_ENDPOINT_ID

python llm_correctness.py \

--model "meta-llama/Llama-2-7b-chat-hf" \

--llm-api "vertexai" \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

```

### SageMaker

SageMaker doesn't return the total number of tokens that are generated by their endpoint, so tokens are counted using the LLama tokenizer.

```bash

export AWS_ACCESS_KEY_ID="YOUR_ACCESS_KEY_ID"

export AWS_SECRET_ACCESS_KEY="YOUR_SECRET_ACCESS_KEY"s

export AWS_SESSION_TOKEN="YOUR_SESSION_TOKEN"

export AWS_REGION_NAME="YOUR_ENDPOINTS_REGION_NAME"

python llm_correctness.py \

--model "llama-2-7b" \

--llm-api "sagemaker" \

--max-num-completed-requests 2 \

--timeout 600 \

--num-concurrent-requests 1 \

--results-dir "result_outputs" \

```

## Saving Results

The results of the load test and correctness test are saved in the results directory specified by the `--results-dir` argument. The results are saved in 2 files, one with the summary metrics of the test, and one with metrics from each individual request that is returned.

# Advanced Usage

The correctness tests were implemented with the following workflow in mind:

```python

import ray

from transformers import LlamaTokenizerFast

from llmperf.ray_clients.openai_chat_completions_client import (

    OpenAIChatCompletionsClient,

)

from llmperf.models import RequestConfig

from llmperf.requests_launcher import RequestsLauncher

# Copying the environment variables and passing them to ray.init() is necessary

# For making any clients work.

ray.init(runtime_env={"env_vars": {"OPENAI_API_BASE" : "https://api.endpoints.anyscale.com/v1",

                                   "OPENAI_API_KEY" : "YOUR_API_KEY"}})

base_prompt = "hello_world"

tokenizer = LlamaTokenizerFast.from_pretrained(

    "hf-internal-testing/llama-tokenizer"

)

base_prompt_len = len(tokenizer.encode(base_prompt))

prompt = (base_prompt, base_prompt_len)

# Create a client for spawning requests

clients = [OpenAIChatCompletionsClient.remote()]

req_launcher = RequestsLauncher(clients)

req_config = RequestConfig(

    model="meta-llama/Llama-2-7b-chat-hf",

    prompt=prompt

    )

req_launcher.launch_requests(req_config)

result = req_launcher.get_next_ready(block=True)

print(result)

```

# Implementing New LLM Clients

To implement a new LLM client, you need to implement the base class `llmperf.ray_llm_client.LLMClient` and decorate it as a ray actor.

```python

from llmperf.ray_llm_client import LLMClient

import ray

@ray.remote

class CustomLLMClient(LLMClient):

    def llm_request(self, request_config: RequestConfig) -> Tuple[Metrics, str, RequestConfig]:

        """Make a single completion request to a LLM API

        Returns:

            Metrics about the performance charateristics of the request.

            The text generated by the request to the LLM API.

            The request_config used to make the request. This is mainly for logging purposes.

        """

        ...

```

# Legacy Codebase

The old LLMPerf code base can be found in the [llmperf-legacy](https://github.com/ray-project/llmval-legacy) repo.