diff --git a/.cursor/rules/llms.mdc b/.cursor/rules/llms.mdc index 6de8f9f08..94a66595e 100644 --- a/.cursor/rules/llms.mdc +++ b/.cursor/rules/llms.mdc @@ -17,7 +17,7 @@ An llm_handle matches the handle (an id of sorts) with the full specification of - llm_version - llm_platform_choice -The declaration of llm_handleslooks like this in toml syntax: +The declaration of llm_handles looks like this in toml syntax: ```toml [llm_handles] gpt-4o-2024-08-06 = { llm_name = "gpt-4o", llm_version = "2024-08-06" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f60f5767..9e3c3bbd2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## [v0.4.1] - 2025-06-16 + +- Changed discord link to the new one: https://go.pipelex.com/discord +- Added `hello-world` example in the `cookbook-examples` of the documentation. + ## [v0.4.0] - 2025-06-16 ### Highlight: Complete documentation overhaul @@ -113,7 +118,7 @@ is_reporting_enabled = true ## [v0.2.13] - 2025-06-06 -- Added Discord badge on the Readme. Join the community! -> https://discord.gg/SReshKQjWt +- Added Discord badge on the Readme. Join the community! -> https://go.pipelex.com/discord - Added a client for the Pipelex API. Join the waitlist -> https://www.pipelex.com/signup - Removed the `run_pipe_code` function. Replaced by `execute_pipeline` in `pipelex.pipeline.execute`. - Added llm deck `llm_for_img_to_text`. diff --git a/README.md b/README.md index 3529a2a7f..eaec2e984 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ alt="PyPI – latest release">

- Discord + Discord YouTube Website Cookbook @@ -275,7 +275,7 @@ We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING. Join our vibrant Discord community to connect with other developers, share your experiences, and get help with your Pipelex projects! -[![Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/SReshKQjWt) +[![Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)](https://go.pipelex.com/discord) ## 💬 Support diff --git a/docs/pages/cookbook-examples/hello-world.md b/docs/pages/cookbook-examples/hello-world.md index c1f7dcddc..60bc763b2 100644 --- a/docs/pages/cookbook-examples/hello-world.md +++ b/docs/pages/cookbook-examples/hello-world.md @@ -10,6 +10,55 @@ You can find the complete code for this example in the Pipelex Cookbook reposito [**➡️ View on GitHub: quick_start/hello_world.py**](https://github.com/Pipelex/pipelex-cookbook/blob/main/quick_start/hello_world.py) +## The Pipeline Explained + +The `hello_world` function demonstrates the simplest possible Pipelex pipeline. It runs a single pipe that generates a haiku about "Hello World". + +```python +import asyncio + +from pipelex import pretty_print +from pipelex.pipelex import Pipelex +from pipelex.pipeline.execute import execute_pipeline + + +async def hello_world(): + + # Execute the pipeline + pipe_output, _ = await execute_pipeline( + pipe_code="hello_world", + ) + + # Print the output + pretty_print(pipe_output, title="Your first Pipelex output") + + +# start Pipelex +Pipelex.make() +# run sample using asyncio +asyncio.run(hello_world()) +``` + +This example shows the minimal setup needed to run a Pipelex pipeline: initialize Pipelex, execute a pipeline by its code name, and pretty-print the results. + +## The Pipeline Definition: `hello_world.toml` + +The pipeline definition is extremely simple - it's a single LLM call that generates a haiku: + +```toml +domain = "quick_start" +definition = "Discovering Pipelex" + +[pipe] +[pipe.hello_world] +PipeLLM = "Write text about Hello World." +output = "Text" +llm = { llm_handle = "gpt-4o-mini", temperature = 0.9, max_tokens = "auto" } +prompt = """ +Write a haiku about Hello World. +""" +``` + ## How to run 1. Clone the cookbook repository: @@ -25,4 +74,6 @@ You can find the complete code for this example in the Pipelex Cookbook reposito 4. Run the example: ```bash python quick_start/hello_world.py - ``` \ No newline at end of file + ``` + +Expected output: A haiku about "Hello World" displayed with pretty formatting. diff --git a/docs/pages/installation/index.md b/docs/pages/installation/index.md index 618dffb6a..a91431937 100644 --- a/docs/pages/installation/index.md +++ b/docs/pages/installation/index.md @@ -61,4 +61,4 @@ Learn more about pipelex_libraries in our [Libraries documentation](../build-rel - `pipelex init-config`: This cli command will create a `pipelex.toml` file at the root of the project, with basic configuration. This configuration file gathers all configuration for feature flags, logging, cost reporting, and so on... Learn more in our [Configuration documentation](../configuration/index.md) -💡 _Any troubles? Have a look at our [Cookbook](https://github.com/Pipelex/pipelex-cookbook)! and come ask for help on our [Discord](https://discord.gg/SReshKQjWt)_ +💡 _Any troubles? Have a look at our [Cookbook](https://github.com/Pipelex/pipelex-cookbook)! and come ask for help on our [Discord](https://go.pipelex.com/discord)_ diff --git a/mkdocs.yml b/mkdocs.yml index 67c537bed..bb376bd13 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,7 +42,7 @@ extra: link: https://x.com/PipelexAI name: Pipelex on X - icon: fontawesome/brands/discord - link: https://discord.gg/SReshKQjWt + link: https://go.pipelex.com/discord name: Pipelex on Discord generator: false diff --git a/pyproject.toml b/pyproject.toml index e1588192e..fd88ac582 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "pipelex" -version = "0.4.0" +version = "0.4.1" description = "Pipelex is an open-source dev tool based on a simple declarative language that lets you define replicable, structured, composable LLM pipelines." authors = [{ name = "Evotis S.A.S.", email = "evotis@pipelex.com" }] maintainers = [{ name = "Pipelex staff", email = "oss@pipelex.com" }]