Skip to content

Commit 039d0f4

Browse files
authored
URL Modification (#249)
1 parent 5269899 commit 039d0f4

File tree

19 files changed

+52
-52
lines changed

19 files changed

+52
-52
lines changed

.github/ISSUE_TEMPLATE/1-feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
label: Checklist
1313
description: Please confirm and check all the following options.
1414
options:
15-
- label: I have searched the [existing issues](https://github.com/oracle-samples/ai-optimizer/issues) for similar feature requests.
15+
- label: I have searched the [existing issues](https://github.com/oracle/ai-optimizer/issues) for similar feature requests.
1616
required: true
1717
- label: I added a descriptive title and summary to this issue.
1818
required: true

.github/ISSUE_TEMPLATE/2-bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ body:
1414
label: Checklist
1515
description: Please confirm and check all the following options.
1616
options:
17-
- label: I have searched the [existing issues](https://github.com/oracle-samples/ai-optimizer/issues) for similar issues.
17+
- label: I have searched the [existing issues](https://github.com/oracle/ai-optimizer/issues) for similar issues.
1818
required: true
1919
- label: I added a very descriptive title to this issue.
2020
required: true

.github/ISSUE_TEMPLATE/3-doc_improvement.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
label: Improve existing documentation
1313
description: Link to documentation page in question (if any)
1414
placeholder: |
15-
https://oracle-samples.github.io/ai-optimizer/...
15+
https://oracle.github.io/ai-optimizer/...
1616
validations:
1717
required: false
1818
- type: textarea

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: 📖 Documentation
4-
url: https://oracle-samples.github.io/ai-optimizer/
4+
url: https://oracle.github.io/ai-optimizer/
55
about: Learn more about how to use the AI Optimizer and Toolkit
66
- name: ❓ Anything else?
77
url: https://oracledevs.slack.com/archives/C089NPXG8AU

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
# Oracle AI Optimizer and Toolkit
22

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

88
## Description
99

1010
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.
1111

1212
## AI Optimizer Features
1313

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

2020
## Getting Started
2121

2222
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.
2323

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

2626
### Prerequisites
2727

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

35-
<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>
35+
<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>
3636

3737
#### Bare-Metal Installation
3838

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

4141
1. Create and activate a Python Virtual Environment:
4242

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

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

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

6767
#### Container Installation
6868

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

7171
1. Build the all-in-one image.
7272

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

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

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

9090
#### Got OCI?
9191

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

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

9999
## Contributing
100100

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

114114

115115
[magic_button]: https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg
116-
[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
116+
[magic_arch_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-iac.zip

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Description
44

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

77
## Getting Started - Documentation
88

docs/content/advanced/helm.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The {{< full_app_ref >}} was specifically designed to run on infrastructure supp
1414

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

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

71-
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).
71+
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).
7272

7373

7474
### Configure values.yaml
7575

76-
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.
76+
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.
7777

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

@@ -171,7 +171,7 @@ Configure Oracle Cloud Infrastructure used by the {{< short_app_ref >}} API Serv
171171
| server.oci_config.user | string | `""` | User OCID. Required when specifying keySecretName. |
172172
| server.oci_config.fingerprint | string | `""` | Fingerprint. Required when specifying keySecretName. |
173173
| server.oci_config.region | string | `""` | Region. Required when oke is true. |
174-
| 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 |
174+
| 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 |
175175
| 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 |
176176

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

265265
1. Add the Helm Repository
266266
```sh
267-
helm repo add ai-optimizer https://oracle-samples.github.io/ai-optimizer/helm
267+
helm repo add ai-optimizer https://oracle.github.io/ai-optimizer/helm
268268
```
269269

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

316316
1. (Optional) Configure for Oracle Cloud Infrastructure
317317

318-
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:
318+
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:
319319

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

353353
1. Add the Helm Repository
354354
```sh
355-
helm repo add ai-optimizer https://oracle-samples.github.io/ai-optimizer/helm
355+
helm repo add ai-optimizer https://oracle.github.io/ai-optimizer/helm
356356
```
357357

358358
1. Deploy the Helm Chart

docs/content/advanced/iac.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ Licensed under the Universal Permissive License v1.0 as shown at http://oss.orac
1010
spell-checker: ignore opentofu ollama imagelink kubeconfig
1111
-->
1212

13-
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.
13+
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.
1414

1515
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.
1616

1717
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:
1818

19-
{{< 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" >}}
19+
{{< 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" >}}
2020

2121
## Virtual Machine
2222

docs/content/client/configuration/model_config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ spell-checker:ignore ollama, mxbai, nomic, thenlper, minilm, uniqueid, huggingfa
1414
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.
1515

1616
{{% notice style="default" title="Model APIs" icon="circle-info" %}}
17-
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).
17+
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).
1818
{{% /notice %}}
1919

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

5151
#### API
5252

53-
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.
53+
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.
5454

5555
There are a number of local AI Model runners that use OpenAI compatible API's, including:
5656
- [LM Studio](https://lmstudio.ai)

docs/content/walkthrough/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,10 +129,10 @@ To enable the **RAG** functionality, access to an embedding model is required. T
129129

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

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

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

138138
```bash

0 commit comments

Comments
 (0)