https://github.com/aleph-alpha/examples
https://github.com/aleph-alpha/examples
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/aleph-alpha/examples
- Owner: Aleph-Alpha
- Created: 2022-09-27T11:52:14.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-21T16:14:58.000Z (almost 3 years ago)
- Last Synced: 2023-08-21T17:35:25.690Z (almost 3 years ago)
- Language: Jupyter Notebook
- Size: 461 KB
- Stars: 13
- Watchers: 8
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Luminous templates
-------------------
This repo provides some training examples for using the Aleph Alpha API.
## Goal
The goal of this repo is to provide a set of examples that can be used to easily understand and use the Aleph Alpha API.
## Getting Started with the Aleph Alpha Luminous Python API
In this collection of materials, you will learn how to use the aleph-alpha-client to use Luminous models in python.
This is intended to give a structured introduction to the client as well as Luminous model fucntionalities.
You can find the exercise Notebooks in the **exercises** folder and the code templates in **boilerplate** folder.
## Downloading the materials
To download the material, we use github. You can download the materials by cloning the repository:
```bash
git clone https://github.com/Aleph-Alpha/examples.git
```
## Overview
### Bootcamp
| Template | Description | Internal Link | Colab Link |
|----------|-------------|---------------| -----------|
| 1 | completion | [Template 1](bootcamp/01_completion.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/bootcamp/01_completion.ipynb)|
| 2 | search | [Template 2](bootcamp/02_search.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/bootcamp/02_search.ipynb)|
| 3 | classify | [Template 3](bootcamp/03_classify.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/bootcamp/03_classify.ipynb)|
| 4 | AtMan | [Template 4](bootcamp/04_atman.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/bootcamp/04_atman.ipynb)|
| 5 | pipeline | [Template 5](bootcamp/05_pipeline.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/bootcamp/05_pipeline.ipynb)|
### Boilerplate
The boilerplate folder contains the code templates for using the API. The templates are structured in the following way:
| Template | Description | Internal Link | Colab Link |
|----------|-------------|---------------| -----------|
| 1 | Calling the API | [Template 1](boilerplate/01_using_client.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/01_using_client.ipynb)|
| 2 | Simple completion | [Template 2](boilerplate/02_prompting.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/02_prompting.ipynb)|
| 3 | Simple search | [Template 3](boilerplate/03_simple_search.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/03_simple_search.ipynb)|
| 4 | Symmetric and Asymmetric Search | [Template 4](boilerplate/04_semantic_search.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/04_semantic_search.ipynb)|
| 5 | Hidden Embeddings | [Template 5](boilerplate/05_hidden_embeddings.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/05_hidden_embeddings.ipynb)|
| 6 | Task-specific Endpoints | [Template 6](boilerplate/06_task_specific_endpoints.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/06_task_specific_endpoints.ipynb)|
| 7 | Simple Gradio extraction app | [Template 8](boilerplate/08_gradio_app.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/08_gradio_app.ipynb)