https://github.com/itk-dev/ai-launchpad
https://github.com/itk-dev/ai-launchpad
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/itk-dev/ai-launchpad
- Owner: itk-dev
- Created: 2024-05-15T06:43:42.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-29T09:34:03.000Z (over 1 year ago)
- Last Synced: 2024-10-29T11:43:25.669Z (over 1 year ago)
- Language: PHP
- Size: 3.48 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# AI Launchpad
This project provides a website for sharing information and documentation about Large Language Modules (LLM). It also
provides a setup for running LLMs locally in [Ollama](https://github.com/ollama/ollama) docker container too allow
testing of modules in a GDPR safe environment.
It is built around PHP 8.3 and Drupal based on docker containers.
__Note__: this project also provides plugins to allow integration with OpenAI API and Azure AI API. This is done through
Drupal's plugin API, which allow other to build new modules that provides connections to other LLM APIs.
For more information about this integration, look at the custom module
[https://github.com/itk-dev/llm_services](https://github.com/itk-dev/llm_services) which provides the default plugins.
## Local development
This project contains a docker compose setup build around [https://github.com/itk-dev/devops_itkdev-docker](https://github.com/itk-dev/devops_itkdev-docker)
which is a simple wrapper script around docker compose using [traefik](https://traefik.io/traefik/) as a revers proxy
to get FQDN to access the site.
If you do not want to use this wrapper, you can substitute the `itkdev-docer-compose` command with normal
`docker compose` remembering to load the right composer file using the `-f ` option.
This setup also assumes that you have a docker network shared with treafik, if you are not using the wrapper, use this
command to create the network first.
```shell
docker network create --driver=bridge --attachable --internal=false frontend
```
### Building assets for the frontend
Run `itkdev-docker-compose run node yarn watch` to continuesly build assets uppon file changes.
Run `itkdev-docker-compose run node yarn build` to build assets once.
### Site installation
Run the following commands to set up the site. This will run a normal Drupal site installation with the existing
configuration that comes with this project.
```shell
itkdev-docker-compose up -d
itkdev-docker-compose composer install
itkdev-docker-compose drush site-install minimal --existing-config -y
```
When the installation is completed, that admin user is created and the password for logging in the outputted. If you
forget the password, use drush uli command to get a one-time-login link (not the uri here only works if you are using
trafik).
```shell
itkdev-docker-compose drush uli --uri="https://launchpad.local.itkdev.dk/"
```
### Access the site
If you are using out `itkdev-docker-compose` simple use the command below to åbne the site in you default browser.
```shell
itkdev-docker-compose open
```
Alternatively you can find the port number that is mapped nginx container that server the site at `http://0.0.0.0:PORT`
by using this command:
```shell
docker compose port nginx 8080
```
### Drupal config
This project uses Drupal's configuration import and export to handle configuration changes and uses the
[config ignore](https://www.drupal.org/project/config_ignore) module to protect some of the site settings form being
overridden. For local and production configuration settings that you do not want to export, please use
`settings.local.php` to override default configuration values.
Export config created from drupal:
```shell
itkdev-docker-compose drush config:export
```
Import config from config files:
```shell
itkdev-docker-compose drush config:import
```
### Coding standards
``` shell name=coding-standards-composer
docker compose run --rm phpfpm composer install
docker compose run --rm phpfpm composer normalize
```
``` shell name=coding-standards-php
docker compose run --rm phpfpm composer install
docker compose run --rm phpfpm composer coding-standards-apply/phpcs
docker compose run --rm phpfpm composer coding-standards-check/phpcs
```
``` shell name=coding-standards-twig
docker compose run --rm phpfpm composer install
docker compose run --rm phpfpm composer coding-standards-apply/twig-cs-fixer
docker compose run --rm phpfpm composer coding-standards-check/twig-cs-fixer
```
``` shell name=coding-standards-markdown
docker run --rm --volume "$PWD:/md" itkdev/markdownlint $(git ls-files *.md) --fix
docker run --rm --volume "$PWD:/md" itkdev/markdownlint $(git ls-files *.md)
```
```shell name="coding-standards-assets"
docker compose run --rm node yarn install
docker compose run --rm node yarn coding-standards-apply
docker compose run --rm node yarn coding-standards-check
```
## Large language models (LLM)
To host models locally, this project ships with [Ollama](https://ollama.com/) which is able to partially load modules as
needed into memory and also enables one to server models without GPUs. This comes at the cost of slower response times
and very high CPU loads, but this is the best solution at this time.
The project does not ship with any models, so before being able to use any models these should be downloaded. Models are
somewhat large (+4 GB) in size. The list of Ollama supported modules can be seen her:
[https://ollama.com/library](https://ollama.com/library)
First find the port that Ollama is located at with this command:
```shell
docker compose port ollama 11434
```
The following command can be used to pull down a model:
```shell
curl http://0.0.0.0:/api/pull -d '{
"name": "llama3"
}'
```
Replacing the `` with the port number form the first command and replacing the module name with the model you
what to download.
The complete Ollama API documentation can be found here: [https://github.com/ollama/ollama/blob/main/docs/api.md](https://github.com/ollama/ollama/blob/main/docs/api.md)
## Production setup
@todo Write this section.