-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: change examples to link to repo
- Loading branch information
Showing
1 changed file
with
1 addition
and
135 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,137 +1,3 @@ | ||
| # Example Clients | ||
|
|
||
| See `examples/` for a complete list. These examples are all made in mind with your current working directory as `horde_sdk` (e.g., `cd horde_sdk`). | ||
|
|
||
| ## Simple Client (sync) Example | ||
| From `examples/ai_horde_client/aihorde_simple_client_example.py`: | ||
|
|
||
| ``` python | ||
| from horde_sdk.ai_horde_api.ai_horde_clients import AIHordeAPISimpleClient | ||
| from horde_sdk.ai_horde_api.apimodels import ImageGenerateAsyncRequest, ImageGeneration | ||
|
|
||
|
|
||
| def simple_generate_example() -> None: | ||
| simple_client = AIHordeAPISimpleClient() | ||
|
|
||
| generations: list[ImageGeneration] = simple_client.image_generate_request( | ||
| ImageGenerateAsyncRequest( | ||
| apikey=ANON_API_KEY, | ||
| prompt="A cat in a hat", | ||
| models=["Deliberate"], | ||
| ), | ||
| ) | ||
|
|
||
| image = simple_client.generation_to_image(generations[0]) | ||
|
|
||
| image.save("cat_in_hat.webp") | ||
|
|
||
| if __name__ == "__main__": | ||
| simple_generate_example() | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ```python | ||
| import argparse | ||
| import asyncio | ||
| from collections.abc import Coroutine | ||
| from pathlib import Path | ||
|
|
||
| import aiohttp | ||
| from PIL.Image import Image | ||
|
|
||
| from horde_sdk import ANON_API_KEY, RequestErrorResponse | ||
| from horde_sdk.ai_horde_api.ai_horde_clients import AIHordeAPIAsyncSimpleClient | ||
| from horde_sdk.ai_horde_api.apimodels import ImageGenerateAsyncRequest, ImageGenerateStatusResponse | ||
| from horde_sdk.ai_horde_api.fields import JobID | ||
|
|
||
|
|
||
| async def async_one_image_generate_example( | ||
| simple_client: AIHordeAPIAsyncSimpleClient, | ||
| apikey: str = ANON_API_KEY, | ||
| ) -> None: | ||
| single_generation_response: ImageGenerateStatusResponse | ||
| job_id: JobID | ||
|
|
||
| single_generation_response, job_id = await simple_client.image_generate_request( | ||
| ImageGenerateAsyncRequest( | ||
| apikey=apikey, | ||
| prompt="A cat in a hat", | ||
| models=["Deliberate"], | ||
| ), | ||
| ) | ||
|
|
||
| if isinstance(single_generation_response, RequestErrorResponse): | ||
| print(f"Error: {single_generation_response.message}") | ||
| else: | ||
| single_image, _ = await simple_client.download_image_from_generation(single_generation_response.generations[0]) | ||
|
|
||
| example_path = Path("examples/requested_images") | ||
| example_path.mkdir(exist_ok=True, parents=True) | ||
|
|
||
| single_image.save(example_path / f"{job_id}_simple_async_example.webp") | ||
|
|
||
|
|
||
| async def async_multi_image_generate_example( | ||
| simple_client: AIHordeAPIAsyncSimpleClient, | ||
| apikey: str = ANON_API_KEY, | ||
| ) -> None: | ||
| multi_generation_responses: tuple[ | ||
| tuple[ImageGenerateStatusResponse, JobID], | ||
| tuple[ImageGenerateStatusResponse, JobID], | ||
| ] | ||
| multi_generation_responses = await asyncio.gather( | ||
| simple_client.image_generate_request( | ||
| ImageGenerateAsyncRequest( | ||
| apikey=apikey, | ||
| prompt="A cat in a blue hat", | ||
| models=["Deliberate"], | ||
| ), | ||
| ), | ||
| simple_client.image_generate_request( | ||
| ImageGenerateAsyncRequest( | ||
| apikey=apikey, | ||
| prompt="A cat in a red hat", | ||
| models=["Deliberate"], | ||
| ), | ||
| ), | ||
| ) | ||
|
|
||
| download_image_from_generation_calls: list[Coroutine[None, None, tuple[Image, JobID]]] = [] | ||
|
|
||
| for status_response, _ in multi_generation_responses: | ||
| download_image_from_generation_calls.append( | ||
| simple_client.download_image_from_generation(status_response.generations[0]), | ||
| ) | ||
|
|
||
| downloaded_images: list[tuple[Image, JobID]] = await asyncio.gather(*download_image_from_generation_calls) | ||
|
|
||
| example_path = Path("examples/requested_images") | ||
| example_path.mkdir(exist_ok=True, parents=True) | ||
|
|
||
| for image, job_id in downloaded_images: | ||
| image.save(example_path / f"{job_id}_simple_async_example.webp") | ||
|
|
||
|
|
||
| async def async_simple_generate_example(apikey: str = ANON_API_KEY) -> None: | ||
| async with aiohttp.ClientSession() as aiohttp_session: | ||
| simple_client = AIHordeAPIAsyncSimpleClient(aiohttp_session) | ||
|
|
||
| await async_one_image_generate_example(simple_client, apikey) | ||
| await async_multi_image_generate_example(simple_client, apikey) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| parser = argparse.ArgumentParser(description="AI Horde API Manual Client Example") | ||
| parser.add_argument( | ||
| "--apikey", | ||
| type=str, | ||
| default=ANON_API_KEY, | ||
| help="The API key to use. Defaults to the anon key.", | ||
| ) | ||
| args = parser.parse_args() | ||
|
|
||
| # Run the example. | ||
| asyncio.run(async_simple_generate_example(args.apikey)) | ||
|
|
||
| ``` | ||
| See `examples/` (https://github.com/Haidra-Org/horde-sdk/tree/main/examples) for a complete list. These examples are all made in mind with your current working directory as `horde_sdk` (e.g., `cd horde_sdk`). |