mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-06-28 02:53:30 +00:00
# What does this PR do? 1) Implement `unregister_dataset(dataset_id)` API in both llama stack routing table and providers: It removes {dataset_id -> Dataset} mapping from routing table and removes the dataset_id references in provider as well (ex. for huggingface, we use a KV store to store the dataset id => dataset. we delete it during unregistering as well) 2) expose the datasets/unregister_dataset api endpoint ## Test Plan **Unit test:** ` pytest llama_stack/providers/tests/datasetio/test_datasetio.py -m "huggingface" -v -s --tb=short --disable-warnings ` **Test on endpoint:** tested llama stack using an ollama distribution template: 1) start an ollama server 2) Start a llama stack server with the default ollama distribution config + dataset/datasetsio APIs + datasetio provider ``` ---- .../ollama-run.yaml ... apis: - agents - inference - memory - safety - telemetry - datasetio - datasets providers: datasetio: - provider_id: localfs provider_type: inline::localfs config: {} ... ``` saw that the new API showed up in startup script ``` Serving API datasets GET /alpha/datasets/get GET /alpha/datasets/list POST /alpha/datasets/register POST /alpha/datasets/unregister ``` 3) query `/alpha/datasets/unregister` through curl (since we have not implemented unregister api in llama stack client) ``` (base) sxyi@sxyi-mbp llama-stack % llama-stack-client datasets register --dataset-id sixian --url https://raw.githubusercontent.com/pytorch/torchtune/main/docs/source/tutorials/chat.rst --schema {} (base) sxyi@sxyi-mbp llama-stack % llama-stack-client datasets list ┏━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓ ┃ identifier ┃ provider_id ┃ metadata ┃ type ┃ ┡━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩ │ sixian │ localfs │ {} │ dataset │ └────────────┴─────────────┴──────────┴─────────┘ (base) sxyi@sxyi-mbp llama-stack % llama-stack-client datasets register --dataset-id sixian2 --url https://raw.githubusercontent.com/pytorch/torchtune/main/docs/source/tutorials/chat.rst --schema {} (base) sxyi@sxyi-mbp llama-stack % llama-stack-client datasets list ┏━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓ ┃ identifier ┃ provider_id ┃ metadata ┃ type ┃ ┡━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩ │ sixian │ localfs │ {} │ dataset │ │ sixian2 │ localfs │ {} │ dataset │ └────────────┴─────────────┴──────────┴─────────┘ (base) sxyi@sxyi-mbp llama-stack % curl http://localhost:5001/alpha/datasets/unregister \ -H "Content-Type: application/json" \ -d '{"dataset_id": "sixian"}' null% (base) sxyi@sxyi-mbp llama-stack % llama-stack-client datasets list ┏━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓ ┃ identifier ┃ provider_id ┃ metadata ┃ type ┃ ┡━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩ │ sixian2 │ localfs │ {} │ dataset │ └────────────┴─────────────┴──────────┴─────────┘ (base) sxyi@sxyi-mbp llama-stack % curl http://localhost:5001/alpha/datasets/unregister \ -H "Content-Type: application/json" \ -d '{"dataset_id": "sixian2"}' null% (base) sxyi@sxyi-mbp llama-stack % llama-stack-client datasets list ``` ## Sources ## Before submitting - [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). - [ ] Ran pre-commit to handle lint / formatting issues. - [ ] Read the [contributor guideline](https://github.com/meta-llama/llama-stack/blob/main/CONTRIBUTING.md), Pull Request section? - [ ] Updated relevant documentation. - [ ] Wrote necessary unit or integration tests.
131 lines
3.8 KiB
Python
131 lines
3.8 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
import asyncio
|
|
import json
|
|
import os
|
|
from pathlib import Path
|
|
from typing import Optional
|
|
|
|
import fire
|
|
import httpx
|
|
from termcolor import cprint
|
|
|
|
from .datasets import * # noqa: F403
|
|
from llama_stack.apis.datasets import * # noqa: F403
|
|
from llama_stack.apis.common.type_system import * # noqa: F403
|
|
from llama_stack.providers.tests.datasetio.test_datasetio import data_url_from_file
|
|
|
|
|
|
class DatasetsClient(Datasets):
|
|
def __init__(self, base_url: str):
|
|
self.base_url = base_url
|
|
|
|
async def initialize(self) -> None:
|
|
pass
|
|
|
|
async def shutdown(self) -> None:
|
|
pass
|
|
|
|
async def register_dataset(
|
|
self,
|
|
dataset_def: DatasetDefWithProvider,
|
|
) -> None:
|
|
async with httpx.AsyncClient() as client:
|
|
response = await client.post(
|
|
f"{self.base_url}/datasets/register",
|
|
json={
|
|
"dataset_def": json.loads(dataset_def.json()),
|
|
},
|
|
headers={"Content-Type": "application/json"},
|
|
timeout=60,
|
|
)
|
|
response.raise_for_status()
|
|
return
|
|
|
|
async def get_dataset(
|
|
self,
|
|
dataset_identifier: str,
|
|
) -> Optional[DatasetDefWithProvider]:
|
|
async with httpx.AsyncClient() as client:
|
|
response = await client.get(
|
|
f"{self.base_url}/datasets/get",
|
|
params={
|
|
"dataset_identifier": dataset_identifier,
|
|
},
|
|
headers={"Content-Type": "application/json"},
|
|
timeout=60,
|
|
)
|
|
response.raise_for_status()
|
|
if not response.json():
|
|
return
|
|
|
|
return DatasetDefWithProvider(**response.json())
|
|
|
|
async def list_datasets(self) -> List[DatasetDefWithProvider]:
|
|
async with httpx.AsyncClient() as client:
|
|
response = await client.get(
|
|
f"{self.base_url}/datasets/list",
|
|
headers={"Content-Type": "application/json"},
|
|
timeout=60,
|
|
)
|
|
response.raise_for_status()
|
|
if not response.json():
|
|
return
|
|
|
|
return [DatasetDefWithProvider(**x) for x in response.json()]
|
|
|
|
async def unregister_dataset(
|
|
self,
|
|
dataset_id: str,
|
|
) -> None:
|
|
async with httpx.AsyncClient() as client:
|
|
response = await client.delete(
|
|
f"{self.base_url}/datasets/unregister",
|
|
params={
|
|
"dataset_id": dataset_id,
|
|
},
|
|
headers={"Content-Type": "application/json"},
|
|
timeout=60,
|
|
)
|
|
response.raise_for_status()
|
|
|
|
|
|
async def run_main(host: str, port: int):
|
|
client = DatasetsClient(f"http://{host}:{port}")
|
|
|
|
# register dataset
|
|
test_file = (
|
|
Path(os.path.abspath(__file__)).parent.parent.parent
|
|
/ "providers/tests/datasetio/test_dataset.csv"
|
|
)
|
|
test_url = data_url_from_file(str(test_file))
|
|
response = await client.register_dataset(
|
|
DatasetDefWithProvider(
|
|
identifier="test-dataset",
|
|
provider_id="meta0",
|
|
url=URL(
|
|
uri=test_url,
|
|
),
|
|
dataset_schema={
|
|
"generated_answer": StringType(),
|
|
"expected_answer": StringType(),
|
|
"input_query": StringType(),
|
|
},
|
|
)
|
|
)
|
|
|
|
# list datasets
|
|
list_dataset = await client.list_datasets()
|
|
cprint(list_dataset, "blue")
|
|
|
|
|
|
def main(host: str, port: int):
|
|
asyncio.run(run_main(host, port))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
fire.Fire(main)
|