Skip to content

Commit a9521b6

Browse files
committed
Updated Readme for installation instructions
1 parent a56bda3 commit a9521b6

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,32 @@ Originally created as a demo for the talk [»Have you met ada? - Word Embeddings
1010
this package is
1111
functional yet designed to encourage further development and contributions.
1212

13+
**Please note that this package is still in development and may not be suitable for production use.**
14+
1315
## Installation
1416

15-
Install via composer:
17+
At the moment, the installation process depends on the `"minimum-stability"` setting in your `composer.json`. If you have
18+
`"minimum-stability": "dev"`, you can install the package directly:
1619

1720
```bash
1821
composer require fiveam-code/ada-laravel
1922
```
2023

21-
Ensure that your database is configured to use PostgreSQL with the vector extension.
24+
Otherwise, you need to add the package with a temporary dev dependency to your `composer.json`:
25+
26+
```json
27+
{
28+
"require": {
29+
"fiveam-code/ada-laravel": "^0.1.0",
30+
"rajentrivedi/tokenizer-x": "dev-upgrade-laravel-11 as 1.0.0"
31+
}
32+
}
33+
```
34+
35+
Then you can run `composer update` to install the package.
36+
37+
Ensure that your database is configured to use PostgreSQL with the vector extension. The package will enable the extension
38+
via a migration if it is not already enabled.
2239

2340
Publish the migrations and run them:
2441

@@ -97,10 +114,8 @@ The lookup method allows for direct querying of your model's stored knowledge, f
97114
retrieves the most contextually relevant information using vector similarity.
98115

99116
```php
100-
use App\Models\Paper;
101117
use Ada\Models\Embedding;
102118

103-
$paper = Paper::first();
104119
$answer = Embedding::lookup("Where does the PHP elephant live?");
105120

106121
// "The PHP elephant inhabits 'Silicon Forests'—regions where natural woodlands merge seamlessly with data-rich environments. These forests are dense with both foliage and floating data points."
@@ -131,7 +146,6 @@ If you want to further customize the prompt, you can pass an object form a class
131146
to the `lookup` method:
132147

133148
```php
134-
use App\Models\Paper;
135149
use Ada\Models\Embedding;
136150
use Ada\Tools\Prompts\OpenAIPrompt;
137151

0 commit comments

Comments
 (0)