diff --git a/.github/ISSUE_TEMPLATE/1-feature_request.yml b/.github/ISSUE_TEMPLATE/1-feature_request.yml index 36b05543..632672d7 100644 --- a/.github/ISSUE_TEMPLATE/1-feature_request.yml +++ b/.github/ISSUE_TEMPLATE/1-feature_request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/2-bug_report.yml b/.github/ISSUE_TEMPLATE/2-bug_report.yml index 92564137..0bf22340 100644 --- a/.github/ISSUE_TEMPLATE/2-bug_report.yml +++ b/.github/ISSUE_TEMPLATE/2-bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/3-doc_improvement.yml b/.github/ISSUE_TEMPLATE/3-doc_improvement.yml index 04b16a30..66fd73bc 100644 --- a/.github/ISSUE_TEMPLATE/3-doc_improvement.yml +++ b/.github/ISSUE_TEMPLATE/3-doc_improvement.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 87055d0c..e9c9a54e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/README.md b/README.md index c3f05de5..2cce645e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Oracle AI Optimizer and Toolkit - - - + + + ## Description @@ -11,17 +11,17 @@ The **Oracle AI Optimizer and Toolkit** (the **AI Optimizer**) provides a stream ## 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 @@ -32,11 +32,11 @@ For more information, including more details on **Setup and Configuration** plea - API Keys for Third-Party Models - On-Premises Models\* -\*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. +\*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. #### 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: @@ -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. @@ -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? @@ -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 @@ -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 \ No newline at end of file +[magic_arch_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-iac.zip \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index a77989ca..ed189724 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/docs/content/advanced/helm.md b/docs/content/advanced/helm.md index e6205897..cc5b480d 100644 --- a/docs/content/advanced/helm.md +++ b/docs/content/advanced/helm.md @@ -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" %}} @@ -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. @@ -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 @@ -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: @@ -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 @@ -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 diff --git a/docs/content/advanced/iac.md b/docs/content/advanced/iac.md index 75ee1e4b..341d4326 100644 --- a/docs/content/advanced/iac.md +++ b/docs/content/advanced/iac.md @@ -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 diff --git a/docs/content/client/configuration/model_config.md b/docs/content/client/configuration/model_config.md index 16cdf8d4..ec6c0fec 100644 --- a/docs/content/client/configuration/model_config.md +++ b/docs/content/client/configuration/model_config.md @@ -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 | @@ -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) diff --git a/docs/content/walkthrough/_index.md b/docs/content/walkthrough/_index.md index 162e7323..40651391 100644 --- a/docs/content/walkthrough/_index.md +++ b/docs/content/walkthrough/_index.md @@ -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 diff --git a/docs/hugo.toml b/docs/hugo.toml index f921aad1..ee4fded4 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -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" @@ -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 = " GitHub Repository" - url = 'https://github.com/oracle-samples/ai-optimizer' + url = 'https://github.com/oracle/ai-optimizer' weight = 10 [[menu.shortcuts]] name = "Building a Chatbot" diff --git a/docs/layouts/partials/content-footer.html b/docs/layouts/partials/content-footer.html index 6c62b4ef..cfea09e4 100644 --- a/docs/layouts/partials/content-footer.html +++ b/docs/layouts/partials/content-footer.html @@ -11,7 +11,7 @@
Built with by ORACLE
+Built with by ORACLE
@@ -23,9 +23,9 @@ if (!container) return; container.innerHTML = ` - Download - Star - Fork + Download + Star + Fork `; // Load GitHub Buttons script diff --git a/helm/Chart.yaml b/helm/Chart.yaml index fe4d23b2..17590426 100644 --- a/helm/Chart.yaml +++ b/helm/Chart.yaml @@ -4,11 +4,11 @@ description: A Helm chart Oracle AI Optimizer and Toolkit version: 1.1.0 appVersion: "1.1.0" type: application -home: https://github.com/oracle-samples/ai-optimizer +home: https://github.com/oracle/ai-optimizer sources: - - https://github.com/oracle-samples/ai-optimizer -icon: https://github.com/oracle-samples/ai-optimizer/blob/main/src/client/media/logo.png + - https://github.com/oracle/ai-optimizer +icon: https://github.com/oracle/ai-optimizer/blob/main/src/client/media/logo.png maintainers: - name: Oracle email: obaas_ww@oracle.com - url: https://github.com/oracle-samples/ai-optimizer + url: https://github.com/oracle/ai-optimizer diff --git a/opentofu/cfgmgt/apply.py b/opentofu/cfgmgt/apply.py index 6527c8d5..662d0009 100644 --- a/opentofu/cfgmgt/apply.py +++ b/opentofu/cfgmgt/apply.py @@ -12,7 +12,7 @@ # --- Constants --- HELM_NAME = "ai-optimizer" -HELM_REPO = "https://oracle-samples.github.io/ai-optimizer/helm" +HELM_REPO = "https://oracle.github.io/ai-optimizer/helm" STAGE_PATH = os.path.join(os.path.dirname(__file__), "stage") os.environ["KUBECONFIG"] = os.path.join(STAGE_PATH, "kubeconfig") diff --git a/opentofu/modules/kubernetes/templates/k8s_manifest.yaml b/opentofu/modules/kubernetes/templates/k8s_manifest.yaml index a759fd67..653b4f2d 100644 --- a/opentofu/modules/kubernetes/templates/k8s_manifest.yaml +++ b/opentofu/modules/kubernetes/templates/k8s_manifest.yaml @@ -110,7 +110,7 @@ spec: - sh - -c - | - wget -qO- https://github.com/oracle-samples/ai-optimizer/releases/latest/download/ai-optimizer-src.tar.gz \ + wget -qO- https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-src.tar.gz \ | tar -xz -C /workspace securityContext: runAsUser: 1000 diff --git a/opentofu/modules/vm/templates/cloudinit-compute.tpl b/opentofu/modules/vm/templates/cloudinit-compute.tpl index 74d2598c..e5619ba6 100644 --- a/opentofu/modules/vm/templates/cloudinit-compute.tpl +++ b/opentofu/modules/vm/templates/cloudinit-compute.tpl @@ -60,7 +60,7 @@ write_files: # Setup for Instance Principles # Download/Setup Source Code - curl -L https://github.com/oracle-samples/ai-optimizer/releases/latest/download/ai-optimizer-src.tar.gz \ + curl -L https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-src.tar.gz \ | tar -xz -C /app cd /app python3.11 -m venv .venv diff --git a/opentofu/schema.yaml b/opentofu/schema.yaml index bd9975b0..8fc21bbb 100644 --- a/opentofu/schema.yaml +++ b/opentofu/schema.yaml @@ -4,7 +4,7 @@ title: "Oracle AI Optimizer and Toolkit" description: "Explore the capabilities of AI with the Oracle Database." -informationalText: "https://oracle-samples.github.io/ai-optimizer/" +informationalText: "https://oracle.github.io/ai-optimizer/" schemaVersion: 1.1.0 version: "20190304" # spell-checker: disable-next-line diff --git a/src/launch_client.py b/src/launch_client.py index 1ec2b1a3..0ee360c4 100644 --- a/src/launch_client.py +++ b/src/launch_client.py @@ -71,8 +71,8 @@ def main() -> None: layout="wide", initial_sidebar_state="expanded", menu_items={ - "Get Help": "https://oracle-samples.github.io/ai-optimizer/", - "Report a bug": "https://github.com/oracle-samples/ai-optimizer/issues/new", + "Get Help": "https://oracle.github.io/ai-optimizer/", + "Report a bug": "https://github.com/oracle/ai-optimizer/issues/new", "About": f"v{__version__}", }, )