From c87b7006fc64c7ce7a01ea840eeab2d29ad0a128 Mon Sep 17 00:00:00 2001 From: Xi Yan Date: Thu, 13 Mar 2025 00:03:06 -0700 Subject: [PATCH] docs --- docs/_static/llama-stack-spec.html | 14 +++++++------- docs/_static/llama-stack-spec.yaml | 16 ++++++++-------- llama_stack/apis/datasets/datasets.py | 12 ++++++------ 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/_static/llama-stack-spec.html b/docs/_static/llama-stack-spec.html index b35c325a8..fb54a3a3a 100644 --- a/docs/_static/llama-stack-spec.html +++ b/docs/_static/llama-stack-spec.html @@ -6813,8 +6813,8 @@ "post-training/messages", "eval/question-answer", "eval/messages-answer", - "scoring/question-generation-answer", - "scoring/messages-generation-answer", + "scoring/question-answer-generation", + "scoring/messages-answer-generation", "scoring/generation-answer" ], "title": "DatasetPurpose", @@ -8797,8 +8797,8 @@ "post-training/messages", "eval/question-answer", "eval/messages-answer", - "scoring/question-generation-answer", - "scoring/messages-generation-answer", + "scoring/question-answer-generation", + "scoring/messages-answer-generation", "scoring/generation-answer" ], "title": "DatasetPurpose", @@ -9895,11 +9895,11 @@ "post-training/messages", "eval/question-answer", "eval/messages-answer", - "scoring/question-generation-answer", - "scoring/messages-generation-answer", + "scoring/question-answer-generation", + "scoring/messages-answer-generation", "scoring/generation-answer" ], - "description": "The purpose of the dataset. One of - \"post-training/messages\": The dataset contains a messages column with list of messages for post-training. { \"messages\": [ {\"role\": \"user\", \"content\": \"Hello, world!\"}, {\"role\": \"assistant\", \"content\": \"Hello, world!\"}, ] } - \"eval/question-answer\": The dataset contains a question column and an answer column for evaluation. { \"question\": \"What is the capital of France?\", \"answer\": \"Paris\" } - \"eval/messages-answer\": The dataset contains a messages column with list of messages and an answer column for evaluation. { \"messages\": [ {\"role\": \"user\", \"content\": \"Hello, my name is John Doe.\"}, {\"role\": \"assistant\", \"content\": \"Hello, John Doe. How can I help you today?\"}, {\"role\": \"user\", \"content\": \"What's my name?\"}, ], \"answer\": \"John Doe\" } - \"scoring/question-generation-answer\": The dataset contains a question column, a generation column and an answer column for scoring. { \"question\": \"What is the capital of France?\", \"generation\": \"Paris\", \"answer\": \"Paris\" } - \"scoring/messages-generation-answer\": The dataset contains a messages column with list of messages, a generation column and an answer column for scoring. { \"messages\": [ {\"role\": \"user\", \"content\": \"Hello, my name is John Doe.\"}, {\"role\": \"assistant\", \"content\": \"Hello, John Doe. How can I help you today?\"}, {\"role\": \"user\", \"content\": \"What's my name?\"}, ], \"generation\": \"John Doe\", \"answer\": \"John Doe\" } - \"scoring/generation-answer\": The dataset contains a generation column and an answer column for scoring. { \"generation\": \"Paris\", \"answer\": \"Paris\" }" + "description": "The purpose of the dataset. One of - \"post-training/messages\": The dataset contains a messages column with list of messages for post-training. { \"messages\": [ {\"role\": \"user\", \"content\": \"Hello, world!\"}, {\"role\": \"assistant\", \"content\": \"Hello, world!\"}, ] } - \"eval/question-answer\": The dataset contains a question column and an answer column for evaluation. { \"question\": \"What is the capital of France?\", \"answer\": \"Paris\" } - \"eval/messages-answer\": The dataset contains a messages column with list of messages and an answer column for evaluation. { \"messages\": [ {\"role\": \"user\", \"content\": \"Hello, my name is John Doe.\"}, {\"role\": \"assistant\", \"content\": \"Hello, John Doe. How can I help you today?\"}, {\"role\": \"user\", \"content\": \"What's my name?\"}, ], \"answer\": \"John Doe\" } - \"scoring/question-answer-generation\": The dataset contains a question column, a generation column and an answer column for scoring. { \"question\": \"What is the capital of France?\", \"generation\": \"Paris\", \"answer\": \"Paris\" } - \"scoring/messages-answer-generation\": The dataset contains a messages column with list of messages, a generation column and an answer column for scoring. { \"messages\": [ {\"role\": \"user\", \"content\": \"Hello, my name is John Doe.\"}, {\"role\": \"assistant\", \"content\": \"Hello, John Doe. How can I help you today?\"}, {\"role\": \"user\", \"content\": \"What's my name?\"}, ], \"generation\": \"John Doe\", \"answer\": \"John Doe\" } - \"scoring/generation-answer\": The dataset contains a generation column and an answer column for scoring. { \"generation\": \"Paris\", \"answer\": \"Paris\" }" }, "source": { "$ref": "#/components/schemas/DataSource", diff --git a/docs/_static/llama-stack-spec.yaml b/docs/_static/llama-stack-spec.yaml index 54d548e57..ff6ee717a 100644 --- a/docs/_static/llama-stack-spec.yaml +++ b/docs/_static/llama-stack-spec.yaml @@ -4718,8 +4718,8 @@ components: - post-training/messages - eval/question-answer - eval/messages-answer - - scoring/question-generation-answer - - scoring/messages-generation-answer + - scoring/question-answer-generation + - scoring/messages-answer-generation - scoring/generation-answer title: DatasetPurpose description: >- @@ -6075,8 +6075,8 @@ components: - post-training/messages - eval/question-answer - eval/messages-answer - - scoring/question-generation-answer - - scoring/messages-generation-answer + - scoring/question-answer-generation + - scoring/messages-answer-generation - scoring/generation-answer title: DatasetPurpose description: >- @@ -6786,8 +6786,8 @@ components: - post-training/messages - eval/question-answer - eval/messages-answer - - scoring/question-generation-answer - - scoring/messages-generation-answer + - scoring/question-answer-generation + - scoring/messages-answer-generation - scoring/generation-answer description: >- The purpose of the dataset. One of - "post-training/messages": The dataset @@ -6800,10 +6800,10 @@ components: column for evaluation. { "messages": [ {"role": "user", "content": "Hello, my name is John Doe."}, {"role": "assistant", "content": "Hello, John Doe. How can I help you today?"}, {"role": "user", "content": "What's - my name?"}, ], "answer": "John Doe" } - "scoring/question-generation-answer": + my name?"}, ], "answer": "John Doe" } - "scoring/question-answer-generation": The dataset contains a question column, a generation column and an answer column for scoring. { "question": "What is the capital of France?", "generation": - "Paris", "answer": "Paris" } - "scoring/messages-generation-answer": The + "Paris", "answer": "Paris" } - "scoring/messages-answer-generation": The dataset contains a messages column with list of messages, a generation column and an answer column for scoring. { "messages": [ {"role": "user", "content": "Hello, my name is John Doe."}, {"role": "assistant", "content": diff --git a/llama_stack/apis/datasets/datasets.py b/llama_stack/apis/datasets/datasets.py index 812b373f9..e0ac542fa 100644 --- a/llama_stack/apis/datasets/datasets.py +++ b/llama_stack/apis/datasets/datasets.py @@ -38,13 +38,13 @@ class DatasetPurpose(Enum): ], "answer": "John Doe" } - :cvar scoring/question-generation-answer: The dataset contains a question column, a generation column and an answer column. + :cvar scoring/question-answer-generation: The dataset contains a question column, a generation column and an answer column. { "question": "What is the capital of France?", "generation": "Paris", "answer": "Paris" } - :cvar scoring/messages-generation-answer: The dataset contains a messages column with list of messages, a generation column and an answer column. + :cvar scoring/messages-answer-generation: The dataset contains a messages column with list of messages, a generation column and an answer column. { "messages": [ {"role": "user", "content": "Hello, my name is John Doe."}, @@ -65,8 +65,8 @@ class DatasetPurpose(Enum): eval_question_answer = "eval/question-answer" eval_messages_answer = "eval/messages-answer" - scoring_question_generation_answer = "scoring/question-generation-answer" - scoring_messages_generation_answer = "scoring/messages-generation-answer" + scoring_question_answer_generation = "scoring/question-answer-generation" + scoring_messages_answer_generation = "scoring/messages-answer-generation" scoring_generation_answer = "scoring/generation-answer" # TODO: add more schemas here @@ -206,13 +206,13 @@ class Datasets(Protocol): ], "answer": "John Doe" } - - "scoring/question-generation-answer": The dataset contains a question column, a generation column and an answer column for scoring. + - "scoring/question-answer-generation": The dataset contains a question column, a generation column and an answer column for scoring. { "question": "What is the capital of France?", "generation": "Paris", "answer": "Paris" } - - "scoring/messages-generation-answer": The dataset contains a messages column with list of messages, a generation column and an answer column for scoring. + - "scoring/messages-answer-generation": The dataset contains a messages column with list of messages, a generation column and an answer column for scoring. { "messages": [ {"role": "user", "content": "Hello, my name is John Doe."},