You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,17 +10,17 @@ The **Oracle AI Optimizer and Toolkit** (the **AI Optimizer**) provides a stream
10
10
11
11
## AI Optimizer Features
12
12
13
-
-[Configuring Embedding and Chat Models](https://oracle-samples.github.io/ai-explorer/client/configuration/model_config)
14
-
-[Splitting and Embedding Documentation](https://oracle-samples.github.io/ai-explorer/client/tools/split_embed)
15
-
-[Modifying System Prompts (Prompt Engineering)](https://oracle-samples.github.io/ai-explorer/client/tools/prompt_eng)
16
-
-[Experimenting with **LLM** Parameters](https://oracle-samples.github.io/ai-explorer/client/chatbot)
17
-
-[Testbed for auto-generated or existing Q&A datasets](https://oracle-samples.github.io/ai-explorer/client/testbed)
13
+
-[Configuring Embedding and Chat Models](https://oracle-samples.github.io/ai-optimizer/client/configuration/model_config)
14
+
-[Splitting and Embedding Documentation](https://oracle-samples.github.io/ai-optimizer/client/tools/split_embed)
15
+
-[Modifying System Prompts (Prompt Engineering)](https://oracle-samples.github.io/ai-optimizer/client/tools/prompt_eng)
16
+
-[Experimenting with **LLM** Parameters](https://oracle-samples.github.io/ai-optimizer/client/chatbot)
17
+
-[Testbed for auto-generated or existing Q&A datasets](https://oracle-samples.github.io/ai-optimizer/client/testbed)
18
18
19
19
## Getting Started
20
20
21
21
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.
22
22
23
-
For more information, including more details on **Setup and Configuration** please visit the [documentation](https://oracle-samples.github.io/ai-explorer).
23
+
For more information, including more details on **Setup and Configuration** please visit the [documentation](https://oracle-samples.github.io/ai-optimizer).
24
24
25
25
### Prerequisites
26
26
@@ -31,11 +31,11 @@ For more information, including more details on **Setup and Configuration** plea
31
31
- API Keys for Third-Party Models
32
32
- On-Premises Models<sub>\*</sub>
33
33
34
-
<sub>\*Oracle recommends running On-Premises Models on hardware with GPUs. For more information, please review the [Infrastructure](https://oracle-samples.github.io/ai-explorer/infrastructure) documentation.</sub>
34
+
<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
35
36
36
#### Bare-Metal Installation
37
37
38
-
To run the application on bare-metal; download the [source](https://github.com/oracle-samples/ai-explorer) and from `src/`:
38
+
To run the application on bare-metal; download the [source](https://github.com/oracle-samples/ai-optimizer) and from `src/`:
39
39
40
40
1. Create and activate a Python Virtual Environment:
41
41
@@ -61,11 +61,11 @@ To run the application on bare-metal; download the [source](https://github.com/o
61
61
62
62
1. Navigate to `http://localhost:8501`.
63
63
64
-
1.[Configure](https://oracle-samples.github.io/ai-explorer/client/configuration) the **AI Optimizer**.
64
+
1.[Configure](https://oracle-samples.github.io/ai-optimizer/client/configuration) the **AI Optimizer**.
65
65
66
66
#### Container Installation
67
67
68
-
To run the application in a container; download the [source](https://github.com/oracle-samples/ai-explorer):
68
+
To run the application in a container; download the [source](https://github.com/oracle-samples/ai-optimizer):
69
69
70
70
1. Build the all-in-one image.
71
71
@@ -84,7 +84,7 @@ To run the application in a container; download the [source](https://github.com/
84
84
85
85
1. Navigate to `http://localhost:8501`.
86
86
87
-
1.[Configure](https://oracle-samples.github.io/ai-explorer/client/configuration/index.html) the **AI Optimizer**.
87
+
1.[Configure](https://oracle-samples.github.io/ai-optimizer/client/configuration/index.html) the **AI Optimizer**.
88
88
89
89
##### Got OCI?
90
90
The **AI Optimizer** can be deployed with an Oracle Autonomous Database 23ai using infrastructure as code. Deploy the **AI Optimizer** in Oracle Cloud Infrastructure using OCI Resource Manager:
@@ -108,4 +108,4 @@ See [LICENSE](./LICENSE.txt) for more details.
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.
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-explorer/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-samples/ai-optimizer/issues/new).
18
18
{{% /notice %}}
19
19
20
20
| Type | API | Location |
@@ -50,7 +50,7 @@ Set the API, API Keys, API URL and other parameters as required. Parameters suc
50
50
51
51
#### API
52
52
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-explorer/issues/new?template=additional_model_support) 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-samples/ai-optimizer/issues/new?template=additional_model_support) requesting an additional model API support.
54
54
55
55
There are a number of local AI Model runners that use OpenAI compatible API's, including:
0 commit comments