Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/1-feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ body:
label: Checklist
description: Please confirm and check all the following options.
options:
- label: I have searched the [existing issues](https://github.com/oracle-samples/ai-optimizer/issues) for similar feature requests.
- label: I have searched the [existing issues](https://github.com/oracle/ai-optimizer/issues) for similar feature requests.
required: true
- label: I added a descriptive title and summary to this issue.
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/2-bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ body:
label: Checklist
description: Please confirm and check all the following options.
options:
- label: I have searched the [existing issues](https://github.com/oracle-samples/ai-optimizer/issues) for similar issues.
- label: I have searched the [existing issues](https://github.com/oracle/ai-optimizer/issues) for similar issues.
required: true
- label: I added a very descriptive title to this issue.
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/3-doc_improvement.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ body:
label: Improve existing documentation
description: Link to documentation page in question (if any)
placeholder: |
https://oracle-samples.github.io/ai-optimizer/...
https://oracle.github.io/ai-optimizer/...
validations:
required: false
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: 📖 Documentation
url: https://oracle-samples.github.io/ai-optimizer/
url: https://oracle.github.io/ai-optimizer/
about: Learn more about how to use the AI Optimizer and Toolkit
- name: ❓ Anything else?
url: https://oracledevs.slack.com/archives/C089NPXG8AU
Expand Down
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Oracle AI Optimizer and Toolkit

<!-- spell-checker:ignore streamlit, venv, setuptools -->
![Test Status](https://github.com/oracle-samples/ai-optimizer/actions/workflows/pytest.yml/badge.svg)
![IaC Status](https://github.com/oracle-samples/ai-optimizer/actions/workflows/opentofu.yml/badge.svg)
![Build Status](https://github.com/oracle-samples/ai-optimizer/actions/workflows/image_smoke.yml/badge.svg)
![Test Status](https://github.com/oracle/ai-optimizer/actions/workflows/pytest.yml/badge.svg)
![IaC Status](https://github.com/oracle/ai-optimizer/actions/workflows/opentofu.yml/badge.svg)
![Build Status](https://github.com/oracle/ai-optimizer/actions/workflows/image_smoke.yml/badge.svg)

## Description

The **Oracle AI Optimizer and Toolkit** (the **AI Optimizer**) provides a streamlined environment where developers and data scientists can explore the potential of Generative Artificial Intelligence (GenAI) combined with Retrieval-Augmented Generation (RAG) capabilities. By integrating **Oracle Database 23ai** AI VectorSearch and SelectAI, the Sandbox enables users to enhance existing Large Language Models (LLMs) through RAG.

## AI Optimizer Features

- [Configuring Embedding and Chat Models](https://oracle-samples.github.io/ai-optimizer/client/configuration/model_config)
- [Splitting and Embedding Documentation](https://oracle-samples.github.io/ai-optimizer/client/tools/split_embed)
- [Modifying System Prompts (Prompt Engineering)](https://oracle-samples.github.io/ai-optimizer/client/tools/prompt_eng)
- [Experimenting with **LLM** Parameters](https://oracle-samples.github.io/ai-optimizer/client/chatbot)
- [Testbed for auto-generated or existing Q&A datasets](https://oracle-samples.github.io/ai-optimizer/client/testbed)
- [Configuring Embedding and Chat Models](https://oracle.github.io/ai-optimizer/client/configuration/model_config)
- [Splitting and Embedding Documentation](https://oracle.github.io/ai-optimizer/client/tools/split_embed)
- [Modifying System Prompts (Prompt Engineering)](https://oracle.github.io/ai-optimizer/client/tools/prompt_eng)
- [Experimenting with **LLM** Parameters](https://oracle.github.io/ai-optimizer/client/chatbot)
- [Testbed for auto-generated or existing Q&A datasets](https://oracle.github.io/ai-optimizer/client/testbed)

## Getting Started

The **AI Optimizer** is available to install in your own environment, which may be a developer's desktop, on-premises data center environment, or a cloud provider. It can be run either on bare-metal, within a container, or in a Kubernetes Cluster.

For more information, including more details on **Setup and Configuration** please visit the [documentation](https://oracle-samples.github.io/ai-optimizer).
For more information, including more details on **Setup and Configuration** please visit the [documentation](https://oracle.github.io/ai-optimizer).

### Prerequisites

Expand All @@ -32,11 +32,11 @@ For more information, including more details on **Setup and Configuration** plea
- API Keys for Third-Party Models
- On-Premises Models<sub>\*</sub>

<sub>\*Oracle recommends running On-Premises Models on hardware with GPUs. For more information, please review the [Infrastructure](https://oracle-samples.github.io/ai-optimizer/infrastructure) documentation.</sub>
<sub>\*Oracle recommends running On-Premises Models on hardware with GPUs. For more information, please review the [Infrastructure](https://oracle.github.io/ai-optimizer/infrastructure) documentation.</sub>

#### Bare-Metal Installation

To run the application on bare-metal; download the [source](https://github.com/oracle-samples/ai-optimizer) and from `src/`:
To run the application on bare-metal; download the [source](https://github.com/oracle/ai-optimizer) and from `src/`:

1. Create and activate a Python Virtual Environment:

Expand All @@ -62,11 +62,11 @@ To run the application on bare-metal; download the [source](https://github.com/o

1. Navigate to `http://localhost:8501`.

1. [Configure](https://oracle-samples.github.io/ai-optimizer/client/configuration) the **AI Optimizer**.
1. [Configure](https://oracle.github.io/ai-optimizer/client/configuration) the **AI Optimizer**.

#### Container Installation

To run the application in a container; download the [source](https://github.com/oracle-samples/ai-optimizer):
To run the application in a container; download the [source](https://github.com/oracle/ai-optimizer):

1. Build the all-in-one image.

Expand All @@ -85,7 +85,7 @@ To run the application in a container; download the [source](https://github.com/

1. Navigate to `http://localhost:8501`.

1. [Configure](https://oracle-samples.github.io/ai-optimizer/client/configuration/index.html) the **AI Optimizer**.
1. [Configure](https://oracle.github.io/ai-optimizer/client/configuration/index.html) the **AI Optimizer**.

#### Got OCI?

Expand All @@ -94,7 +94,7 @@ The **AI Optimizer** can be deployed in Oracle Cloud Infrastructure (OCI) using
Choose either a light-weight Virtual Machine or robust Oracle Kubernetes Engine deployment, both with an Oracle Autonomous Database 23ai:
[![Deploy to Oracle Cloud][magic_button]][magic_arch_stack]

For more information, please visit the [IaC Documentation](https://oracle-samples.github.io/ai-optimizer/advanced/iac/index.html).
For more information, please visit the [IaC Documentation](https://oracle.github.io/ai-optimizer/advanced/iac/index.html).

## Contributing

Expand All @@ -113,4 +113,4 @@ See [LICENSE](./LICENSE.txt) for more details.


[magic_button]: https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg
[magic_arch_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle-samples/ai-optimizer/releases/latest/download/ai-optimizer-iac.zip
[magic_arch_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-iac.zip
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

This directory contains the documentation for the the [**Oracle AI Optimizer & Toolkit**](https://github.com/oracle-samples/ai-optimizer).
This directory contains the documentation for the the [**Oracle AI Optimizer & Toolkit**](https://github.com/oracle/ai-optimizer).

## Getting Started - Documentation

Expand Down
14 changes: 7 additions & 7 deletions docs/content/advanced/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The {{< full_app_ref >}} was specifically designed to run on infrastructure supp

To use the {{< short_app_ref >}} Helm Chart:
1. [Build, Tag, and Push](#images) the {{< short_app_ref >}} Images
1. [Configure](#configure-valuesyaml) the [values.yaml](https://github.com/oracle-samples/ai-optimizer/blob/main/helm/values.yaml)
1. [Configure](#configure-valuesyaml) the [values.yaml](https://github.com/oracle/ai-optimizer/blob/main/helm/values.yaml)
1. [Deploy!](#deploy)

{{% notice style="code" title="Go Local" icon="laptop" %}}
Expand Down Expand Up @@ -68,12 +68,12 @@ You will need to build the {{< short_app_ref >}} container images and stage them
podman push iad.ocir.io/testing/ai-optimizer-server:latest
```

You will use the URL for the pushed images when [configuring](#configure-valuesyaml) the [values.yaml](https://github.com/oracle-samples/ai-optimizer/blob/main/helm/values.yaml).
You will use the URL for the pushed images when [configuring](#configure-valuesyaml) the [values.yaml](https://github.com/oracle/ai-optimizer/blob/main/helm/values.yaml).


### Configure values.yaml

The [values.yaml](https://github.com/oracle-samples/ai-optimizer/blob/main/helm/values.yaml) allows you to customize the deployment by overriding settings such as image versions, resource requests, service configurations, and more. You can modify this file directly or supply your own overrides during installation using the -f or --set flags.
The [values.yaml](https://github.com/oracle/ai-optimizer/blob/main/helm/values.yaml) allows you to customize the deployment by overriding settings such as image versions, resource requests, service configurations, and more. You can modify this file directly or supply your own overrides during installation using the -f or --set flags.

Only a subset of the most important settings are documented here, review the `values.yaml` file for more configuration options.

Expand Down Expand Up @@ -171,7 +171,7 @@ Configure Oracle Cloud Infrastructure used by the {{< short_app_ref >}} API Serv
| server.oci_config.user | string | `""` | User OCID. Required when specifying keySecretName. |
| server.oci_config.fingerprint | string | `""` | Fingerprint. Required when specifying keySecretName. |
| server.oci_config.region | string | `""` | Region. Required when oke is true. |
| server.oci_config.fileSecretName | string | `""` | Secret containing an OCI config file and the key_file(s). Use the [scripts/oci_config.py](https://github.com/oracle-samples/ai-optimizer/blob/main/helm/scripts/oci_config.py) script to help create the secret based on an existing ~.oci/config file |
| server.oci_config.fileSecretName | string | `""` | Secret containing an OCI config file and the key_file(s). Use the [scripts/oci_config.py](https://github.com/oracle/ai-optimizer/blob/main/helm/scripts/oci_config.py) script to help create the secret based on an existing ~.oci/config file |
| server.oci_config.keySecretName | string | `""` | Secret containing a single API key corresponding to above tenancy configuration This used by OraOperator when not running in OKE |

###### Examples
Expand Down Expand Up @@ -264,7 +264,7 @@ Once your `values.yaml` has been configured and you have a Kubernetes cluster av

1. Add the Helm Repository
```sh
helm repo add ai-optimizer https://oracle-samples.github.io/ai-optimizer/helm
helm repo add ai-optimizer https://oracle.github.io/ai-optimizer/helm
```

2. Apply the `values.yaml` file:
Expand Down Expand Up @@ -315,7 +315,7 @@ Give the **Helm Chart** a spin using a locally installed [Kind](https://kind.sig

1. (Optional) Configure for Oracle Cloud Infrastructure

If you already have an OCI API configuration file, use the [scripts/oci_config.py](https://github.com/oracle-samples/ai-optimizer/blob/main/helm/scripts/oci_config.py) helper script to turn it into a secret for OCI connectivity:
If you already have an OCI API configuration file, use the [scripts/oci_config.py](https://github.com/oracle/ai-optimizer/blob/main/helm/scripts/oci_config.py) helper script to turn it into a secret for OCI connectivity:

```sh
kubectl create namespace ai-optimizer
Expand Down Expand Up @@ -352,7 +352,7 @@ Give the **Helm Chart** a spin using a locally installed [Kind](https://kind.sig

1. Add the Helm Repository
```sh
helm repo add ai-optimizer https://oracle-samples.github.io/ai-optimizer/helm
helm repo add ai-optimizer https://oracle.github.io/ai-optimizer/helm
```

1. Deploy the Helm Chart
Expand Down
4 changes: 2 additions & 2 deletions docs/content/advanced/iac.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Licensed under the Universal Permissive License v1.0 as shown at http://oss.orac
spell-checker: ignore opentofu ollama imagelink kubeconfig
-->

The {{< full_app_ref >}} can easily be deployed in Oracle Cloud Infrastructure (**OCI**) using Infrastructure as Code (**IaC**) provided in the source [opentofu](https://github.com/oracle-samples/ai-optimizer/tree/main/opentofu) directory.
The {{< full_app_ref >}} can easily be deployed in Oracle Cloud Infrastructure (**OCI**) using Infrastructure as Code (**IaC**) provided in the source [opentofu](https://github.com/oracle/ai-optimizer/tree/main/opentofu) directory.

Choose between deploying a light-weight [Virtual Machine](#virtual-machine) or robust [Oracle Kubernetes Engine (**OKE**)](#oracle-kubernetes-engine) along with the **Oracle Autonomous Database** for a fully configured {{< short_app_ref >}} environment, ready to use.

While the **IaC** can be run from a command-line with prior experience, the steps outlined here use [Oracle Cloud Resource Manager](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm) to simplify the process. To get started:

{{< imagelink url="https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle-samples/ai-optimizer/releases/latest/download/ai-optimizer-iac.zip" src="https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg" alt="Deploy to Oracle Cloud" >}}
{{< imagelink url="https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-iac.zip" src="https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg" alt="Deploy to Oracle Cloud" >}}

## Virtual Machine

Expand Down
4 changes: 2 additions & 2 deletions docs/content/client/configuration/model_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ spell-checker:ignore ollama, mxbai, nomic, thenlper, minilm, uniqueid, huggingfa
At a minimum, a Large _Language Model_ (LLM) must be configured in {{< short_app_ref >}} for basic functionality. For Retrieval-Augmented Generation (**RAG**), an _Embedding Model_ will also need to be configured.

{{% notice style="default" title="Model APIs" icon="circle-info" %}}
If there is a specific model API that you would like to use, please [open an issue in GitHub](https://github.com/oracle-samples/ai-optimizer/issues/new).
If there is a specific model API that you would like to use, please [open an issue in GitHub](https://github.com/oracle/ai-optimizer/issues/new).
{{% /notice %}}

| Type | API | Location |
Expand Down Expand Up @@ -50,7 +50,7 @@ Set the API, API Keys, API URL and other parameters as required. Parameters suc

#### API

The {{< short_app_ref >}} supports a number of model API's. When adding a model, choose the most appropriate Model API. If unsure, or the specific API is not listed, try *CompatOpenAI* or *CompatOpenAIEmbeddings* before [opening an issue](https://github.com/oracle-samples/ai-optimizer/issues/new) requesting an additional model API support.
The {{< short_app_ref >}} supports a number of model API's. When adding a model, choose the most appropriate Model API. If unsure, or the specific API is not listed, try *CompatOpenAI* or *CompatOpenAIEmbeddings* before [opening an issue](https://github.com/oracle/ai-optimizer/issues/new) requesting an additional model API support.

There are a number of local AI Model runners that use OpenAI compatible API's, including:
- [LM Studio](https://lmstudio.ai)
Expand Down
4 changes: 2 additions & 2 deletions docs/content/walkthrough/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,10 @@ To enable the **RAG** functionality, access to an embedding model is required. T

The {{< short_app_ref >}} provides an easy to use front-end for experimenting with **LLM** parameters and **RAG**.

1. Download and Unzip the [latest release](https://github.com/oracle-samples/ai-optimizer/releases/latest) of the {{< short_app_ref >}}:
1. Download and Unzip the [latest release](https://github.com/oracle/ai-optimizer/releases/latest) of the {{< short_app_ref >}}:

```bash
curl -LO https://github.com/oracle-samples/ai-optimizer/releases/latest/download/ai-optimizer-src.tar.gz
curl -LO https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-src.tar.gz
```

```bash
Expand Down
6 changes: 3 additions & 3 deletions docs/hugo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Copyright (c) 2024, 2025, Oracle and/or its affiliates.
## Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.

baseURL = 'https://oracle-samples.github.io/ai-optimizer'
baseURL = 'https://oracle.github.io/ai-optimizer'
languageCode = 'en-us'
title = 'Oracle AI Optimizer & Toolkit'
theme = "relearn"
Expand Down Expand Up @@ -30,13 +30,13 @@ enableRobotsTXT = true
hideAuthorName = true
LongName = "Oracle AI Optimizer and Toolkit"
ShortName = "AI Optimizer"
GitHubRepo = "https://github.com/oracle-samples/ai-optimizer"
GitHubRepo = "https://github.com/oracle/ai-optimizer"

[menu]
[[menu.shortcuts]]
identifier = 'ds'
name = "<i class='fa-fw fab fa-github'></i> GitHub Repository"
url = 'https://github.com/oracle-samples/ai-optimizer'
url = 'https://github.com/oracle/ai-optimizer'
weight = 10
[[menu.shortcuts]]
name = "<i class='fa-fw fab fa-youtube'></i>Building a Chatbot"
Expand Down
2 changes: 1 addition & 1 deletion docs/layouts/partials/content-footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ <h1 id="need-help" style="font-size: 1.85em;">Questions? Comments?</h2>
channel in the
<a href="https://oracledevs.slack.com" rel="external" target="_blank" class="highlight">Oracle Developers Slack</a>
workspace, or
<a href="https://github.com/oracle-samples/ai-optimizer/issues/new" rel="external" target="_blank" class="highlight">open an issue in GitHub</a>.
<a href="https://github.com/oracle/ai-optimizer/issues/new" rel="external" target="_blank" class="highlight">open an issue in GitHub</a>.
</p>
<hr/>
<span>Content licensed under Universal Permissive License<a href="https://oss.oracle.com/licenses/upl">© 2025 Oracle and/or its affiliates</a></span>
Expand Down
Loading