chore: move example runner into examples folder including composer setup for examples

Author: chr-hertel

.gitignore

@@ -1,8 +1,6 @@
 .doctor-rst.cache
-.env.local
 .php-cs-fixer.cache
 .phpunit.cache
-.transformers-cache
 
 composer.lock
 vendor

.php-cs-fixer.dist.php

@@ -42,7 +42,7 @@
     ->setRiskyAllowed(true)
     ->setFinder(
         (new PhpCsFixer\Finder())
-            ->in([__DIR__.'/src', __DIR__.'/examples'])
+            ->in([__DIR__.'/src', __DIR__.'/examples', __DIR__.'/fixtures'])
             ->append([__FILE__])
             ->notPath('#/Fixtures/#')
     )

README.md

@@ -683,8 +683,8 @@ foreach ($responses as $response) {
 
 #### Code Examples
 
-1. [Parallel GPT Calls](examples/parallel-chat-gpt.php)
-1. [Parallel Embeddings Calls](examples/parallel-embeddings.php)
+1. [Parallel GPT Calls](examples/misc/parallel-chat-gpt.php)
+1. [Parallel Embeddings Calls](examples/misc/parallel-embeddings.php)
 
 > [!NOTE]
 > Please be aware that some embedding models also support batch processing out of the box.

composer.json

@@ -5,41 +5,13 @@
     "keywords": [
         "dev"
     ],
-    "minimum-stability": "dev",
-    "prefer-stable": true,
     "require-dev": {
         "php": ">=8.2",
-        "async-aws/bedrock-runtime": "^0.1.0",
-        "codewithkyrian/transformers": "^0.5.3",
         "php-cs-fixer/shim": "^3.75",
-        "probots-io/pinecone-php": "^1.0",
-        "symfony/ai-agent": "@dev",
-        "symfony/ai-platform": "@dev",
-        "symfony/ai-store": "@dev",
-        "symfony/console": "^6.4|^7.0",
-        "symfony/css-selector": "^6.4|^7.0",
-        "symfony/dom-crawler": "^6.4|^7.0",
-        "symfony/dotenv": "^6.4|^7.0",
-        "symfony/event-dispatcher": "^6.4|^7.0",
-        "symfony/filesystem": "^6.4|^7.0",
         "symfony/finder": "^6.4|^7.0",
-        "symfony/process": "^6.4|^7.0",
-        "symfony/var-dumper": "^6.4|^7.0"
-    },
-    "repositories": [
-        { "type": "path", "url": "src/agent" },
-        { "type": "path", "url": "src/platform" },
-        { "type": "path", "url": "src/store" }
-    ],
-    "autoload-dev": {
-        "psr-4": {
-            "Symfony\\AI\\Fixtures\\": "fixtures/"
-        }
+        "symfony/process": "^6.4|^7.0"
     },
     "config": {
-        "sort-packages": true,
-        "allow-plugins": {
-            "codewithkyrian/transformers-libsloader": true
-        }
+        "sort-packages": true
     }
 }

.env renamed to examples/.env

@@ -0,0 +1,4 @@
+.env.local
+.transformers-cache
+composer.lock
+vendor

examples/.gitignore

@@ -0,0 +1,53 @@
+# Symfony AI Examples
+
+This directory contains various examples of how to use the Symfony AI components. They are meant to provide a
+reference implementation to help you get started.
+
+On top, the examples are used as integration tests to ensure that the components work as expected.
+
+## Running the examples
+
+### Setup
+
+#### Dependencies
+
+Before running the examples, you need to install the dependencies. You can do this by running:
+
+```bash
+composer install
+```
+
+#### Configuration
+
+Depending on the examples you want to run, you may need to configure the needed API keys. Therefore, you need to create a
+`.env.local` file in the root of the examples directory. This file should contain the environment variables for the
+corresponding example you want to run.
+
+_Now you can run examples standalone or via the example runner._
+
+### Running examples standalone
+
+Every example script is a standalone PHP script that can be run from the command line.
+You can run an example by executing the following command:
+
+```bash
+php openai/openai/chat.php
+```
+
+### Running examples via the example runner
+
+You can also run the examples via the example runner, which takes care of running the examples parallel in
+sub-processes. This is useful if you are contributing to the Symfony AI components and want to ensure that all examples
+work as expected.
+
+You can run the example runner by executing the following command:
+
+```bash
+./runner
+```
+
+If you want to run only examples of a specific subdirectory, you can pass the subdirectory name as an argument:
+
+```bash
+./runner openai
+```

examples/README.md

@@ -16,8 +16,8 @@
 use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\Component\Dotenv\Dotenv;
 
-require_once dirname(__DIR__, 2).'/vendor/autoload.php';
-(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
 if (empty($_ENV['ANTHROPIC_API_KEY'])) {
     echo 'Please set the ANTHROPIC_API_KEY environment variable.'.\PHP_EOL;

examples/anthropic/chat.php

@@ -17,8 +17,8 @@
 use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\Component\Dotenv\Dotenv;
 
-require_once dirname(__DIR__, 2).'/vendor/autoload.php';
-(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
 if (empty($_ENV['ANTHROPIC_API_KEY'])) {
     echo 'Please set the ANTHROPIC_API_KEY environment variable.'.\PHP_EOL;

examples/anthropic/image-input-binary.php

@@ -17,8 +17,8 @@
 use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\Component\Dotenv\Dotenv;
 
-require_once dirname(__DIR__, 2).'/vendor/autoload.php';
-(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
 if (empty($_ENV['ANTHROPIC_API_KEY'])) {
     echo 'Please set the ANTHROPIC_API_KEY environment variable.'.\PHP_EOL;