Skip to content

Commit 20cc16d

Browse files
Merge branch 'oracle-samples:main' into main
2 parents 27e298b + 6302738 commit 20cc16d

34 files changed

+5327
-2
lines changed

ai-quick-actions/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Manager (ORM) or manually. For further information see [Policies](policies/READM
2222
- [Model Evaluation](evaluation-tips.md)
2323
- [Model Registration](register-tips.md)
2424
- [MultiModal Models Tips](multimodal-models-tips.md)
25+
- [Time Series Forecasting](time-series-forecasting/README.md)
2526
- [CLI](cli-tips.md)
2627

2728

@@ -115,5 +116,6 @@ In some cases a more sophisticated solution is needed, for example [fine tuning.
115116
- [Model Evaluation](evaluation-tips.md)
116117
- [Model Registration](register-tips.md)
117118
- [MultiModal Models Tips](multimodal-models-tips.md)
119+
- [Time Series Forecasting](time-series-forecasting/README.md)
118120
- [CLI](cli-tips.md)
119121

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Feedback/Feature Request Submission
2+
3+
The **AI Quick Actions (AQUA)** interface provides a simple way to offer feedback directly from the UI. If you’ve spotted a bug or want to suggest a feature, you can easily submit it through GitHub.
4+
5+
This guide shows you how to do that step-by-step, using the example:
6+
> **"AQUA UI doesn't show container version for model deployment"**
7+
8+
---
9+
10+
## Table of Contents
11+
12+
- [Where to Find the Feedback Link](#where-to-find-the-feedback-link)
13+
- [Filling Out the Feedback Form](#filling-out-the-feedback-form)
14+
- [1. Add a title](#1-add-a-title)
15+
- [2. Feedback Type](#2-feedback-type)
16+
- [3. Summary](#3-summary)
17+
- [4. Steps to Reproduce](#4-steps-to-reproduce)
18+
- [5. Expected Behavior](#5-expected-behavior)
19+
- [6. Actual Behavior](#6-actual-behavior)
20+
- [7. Version or AI Quick Actions](#7-version-or-ai-quick-actions)
21+
- [8. Suggestions or Additional Notes](#8-suggestions-or-additional-notes)
22+
- [Submitting the Feedback](#submitting-the-feedback)
23+
24+
## Where to Find the Feedback Link
25+
26+
At the bottom of the **AI quick actions** banner, you’ll see:
27+
28+
> **"Have ideas or feedback? Let us know!"**
29+
30+
Clicking this link opens a pre-filled GitHub issue template:
31+
[Submit AQUA Feedback](https://github.com/oracle-samples/oci-data-science-ai-samples/issues/new?template=feedback_aqua.yml)
32+
33+
AQUA UI with feedback link
34+
![Feedback_Link](web_assets/feedback-link-banner.png)
35+
36+
---
37+
38+
## Filling Out the Feedback Form
39+
40+
Clicking the link will open a GitHub issue template with several fields. Below is how to fill it using our example: **Container Version Visibility**
41+
42+
> **Tip:** You can attach screenshots, logs, or any other relevant files to most section of the form to make your feedback clearer and more actionable.
43+
---
44+
45+
### 1. Add a title
46+
47+
Select the type of issue you want to report. For this example, it will be a:
48+
49+
> **Container Version Visibility**
50+
51+
52+
_Feedback type dropdown_
53+
![Title](web_assets/feedback-title.png)
54+
55+
---
56+
57+
### 2. Feedback Type
58+
59+
Select the type of issue you want to report. For this example, it will be a:
60+
61+
> **Feature Request**
62+
63+
64+
_Feedback type dropdown_
65+
![Dropdown](web_assets/feedback-type-dropdown.png)
66+
67+
---
68+
69+
### 3. Summary
70+
71+
Use a concise title that clearly states the issue or feature request.
72+
73+
> `AQUA UI doesn't show container version for model deployment`
74+
75+
_Summary_
76+
![Summary](web_assets/feedback-summary.png)
77+
---
78+
79+
### 4. Steps to Reproduce
80+
Describe the exact steps you took that led you to notice the issue or missing feature. This helps others reproduce the scenario and understand where it occurs in the UI. For this example, it will be:
81+
```text
82+
1. Open AQUA UI
83+
2. Go to "Model Deployments"
84+
3. Select a deployed model
85+
4. Notice that the container version is not shown in the UI
86+
```
87+
88+
_Deployment details view with missing container version:_
89+
![MDMissingVersion](web_assets/feedback-md-missing-version.png)
90+
91+
_Steps to Reproduce_
92+
![StepsToReproduce](web_assets/feedback-steps-to-reproduce.png)
93+
94+
---
95+
96+
### 5. Expected Behavior
97+
This helps the team understand what the user expects to see.
98+
```text
99+
The model deployment page should show:
100+
Container Version: v1.8.5
101+
```
102+
_Expected Behavior_
103+
![ExpectedBehavior](web_assets/feedback-expected-behavior.png)
104+
105+
---
106+
107+
### 6. Actual Behavior
108+
Describe what you observed in the UI or behavior that was unexpected or incorrect. This helps the team understand the problem from the user's perspective.
109+
```text
110+
The container version field is not visible. Users cannot confirm which version of the container is deployed.
111+
```
112+
_Actual Behavior_
113+
![ActualBehavior](web_assets/feedback-actual-behavior.png)
114+
115+
---
116+
117+
### 7. Version or AI QUick Actions
118+
119+
Provide details about your environment.
120+
121+
```text
122+
AQUA Version: v1.0.7
123+
```
124+
_Version or AI QUick Actions_
125+
![Version](web_assets/feedback-version.png)
126+
---
127+
128+
### 8. Suggestions or Additional Notes
129+
This optional section lets you suggest improvements, explain why the feature is important, or attach helpful context like screenshots or logs.
130+
```text
131+
Add a new field labeled “Container Version” in the model deployment details card.
132+
This helps with debugging and auditability.
133+
```
134+
135+
_Suggestions or Additional Notes_
136+
![Suggestions](web_assets/feedback-additional-info.png)
137+
138+
---
139+
140+
## Submitting the Feedback
141+
142+
After filling out all fields:
143+
144+
- Review your inputs for clarity
145+
- Click **Create** button
146+
147+
---
148+
149+
150+

ai-quick-actions/policies/README.md

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Setting Up Policies Manually](#setting-up-policies-manually)
88
- [Dynamic Groups](#dynamic-groups)
99
- [Policies](#policies-1)
10+
- [Aqua Policy Verification Tool](#aqua-policy-verification-tool)
1011

1112

1213
---
@@ -121,6 +122,163 @@ These policies and dynamic groups set up the necessary permissions to enable AI
121122
> **Note:** To save fine-tuned models, versioning has to be enabled in the selected Object Storage bucket. See [here](https://docs.oracle.com/iaas/data-science/using/ai-quick-actions-fine-tuning.htm) for more information.
122123
123124
![Setup 3](../web_assets/policies3.png)
125+
126+
## Aqua Policy Verification Tool
127+
128+
The **Aqua Policy Verification Tool** is a command-line utility designed to **validate IAM policies** required to use key features of AI Quick action (AQUA) platform.
129+
130+
It simulates actual operations — like registering models, creating job runs, or accessing object storage — to determine whether the currently configured IAM user/group has sufficient permissions.
131+
132+
Before running real workloads (deploying, fine-tuning, etc.), users can verify they have the **right access privileges**. This tool provides:
133+
- Immediate feedback on missing policies
134+
- Policy hints to help fix permission issues
135+
136+
137+
### How to Use
138+
139+
To run the policy-checks from Notebook terminal:
140+
141+
```bash
142+
ads aqua verify_policies <operation> [OPTIONS]
143+
```
144+
145+
Where `<operation>` is one of:
146+
- `common_policies`
147+
- `model_register`
148+
- `model_deployment`
149+
- `evaluation`
150+
- `finetune`
151+
152+
153+
### Description of Policy Verification Operations
154+
155+
Each operation simulates certain actions in AQUA and checks whether those succeed. Here’s what each one does:
156+
157+
#### 1. `common_policies`
158+
159+
**Purpose**: Verifies basic **read-level permissions** across key Data Science resources.
160+
161+
**Simulated actions**:
162+
- Listing compartments
163+
- Listing models and model version sets
164+
- Listing jobs and job runs
165+
- Listing object storage buckets
166+
- Listing logging groups
167+
- Getting service limits
168+
169+
**Examples:**
170+
171+
```bash
172+
ads aqua verify_policies common_policies
173+
```
174+
175+
176+
#### 2. `model_register`
177+
178+
**Purpose**: Verifies ability to **register a model**, which includes writing artifacts to Object Storage.
179+
180+
**Simulated actions**:
181+
- Managing a specified Object Storage bucket
182+
- Registering a new model in the OCI Data Science platform
183+
- Deleting the test model (cleanup)
184+
185+
>**Note**: This operation will create and delete the following temporary resources, which may incur charges. [[See pricing]](https://www.oracle.com/artificial-intelligence/data-science/pricing/)
186+
> - A model with name `AQUA Policy Verification - Model` in OCI Data Science
187+
> - A test file with name `AQUA Policy Verification - OBJECT STORAGE` to your specified bucket. The model and object will be deleted after verification.
188+
189+
**Examples:**
190+
191+
```bash
192+
ads aqua verify_policies model_register
193+
```
194+
or
195+
```bash
196+
ads aqua verify_policies model_register --bucket my-model-artifacts-bucket
197+
```
198+
199+
200+
#### 3. `model_deployment`
201+
202+
**Purpose**: Verifies ability to **deploy a model** after registration.
203+
204+
**Simulated actions**:
205+
- Registering a model (same as `model_register`)
206+
- Creating a model deployment
207+
- Deleting the deployment and the model (cleanup)
208+
209+
> **Note**: This operation will create and delete the following temporary resources, which may incur charges. [[See pricing]](https://www.oracle.com/artificial-intelligence/data-science/pricing/):
210+
> - A model with name `AQUA Policy Verification - Model`
211+
> - A test file with name `AQUA Policy Verification - OBJECT STORAGE` to your specified bucket.
212+
> - A model deployment named `AQUA Policy Verification - Model Deployment`
213+
> These will be deleted after verification is complete.
214+
215+
**Examples:**
216+
217+
```bash
218+
ads aqua verify_policies model_deployment
219+
```
220+
or
221+
```bash
222+
ads aqua verify_policies model_deployment --bucket my-model-bucket
223+
```
224+
225+
#### 4. `evaluation`
226+
227+
**Purpose**: Verifies policies required for **evaluation workflows**, such as automated testing or validation.
228+
229+
**Simulated actions**:
230+
- Creating and deleting a Model Version Set (MVS)
231+
- Registering a model
232+
- Running a job and job run
233+
- Deleting all test resources
234+
235+
> **Note**: This operation will create and delete the following temporary resources, which may incur charges. [[See pricing]](https://www.oracle.com/artificial-intelligence/data-science/pricing/):
236+
> - A **Model Version Set** named `AQUA Policy Verification - Model Version Set`
237+
> - A model with name `AQUA Policy Verification - Model`
238+
> - A test file with name `AQUA Policy Verification - OBJECT STORAGE` to your specified bucket.
239+
> - A test model (as in `model_register`)
240+
> - A **Job** and **Job Run** named `AQUA Policy Verification - Job` and `AQUA Policy Verification - Job Run`
241+
242+
**Examples:**
243+
244+
```bash
245+
ads aqua verify_policies evaluation
246+
```
247+
or
248+
```bash
249+
ads aqua verify_policies evaluation --bucket eval-bucket
250+
```
251+
252+
253+
#### 5. `finetune`
254+
255+
**Purpose**: Verifies whether you can run a **fine-tuning workflow**, typically involving training jobs, storage, and networking.
256+
257+
**Simulated actions**:
258+
- Validates bucket access (datasets, scripts, model output)
259+
- Optionally verifies subnet access for job runs
260+
- Creates and deletes MVS
261+
- Runs finetune jobs
262+
263+
> **Note**: This operation will create and delete the following temporary resources, which may incur charges. [[See pricing]](https://www.oracle.com/artificial-intelligence/data-science/pricing/):
264+
> - A **Model Version Set** named `AQUA Policy Verification - Model Version Set`
265+
> - A test file with name `AQUA Policy Verification - OBJECT STORAGE` to your specified bucket.
266+
> - A **Job** and **Job Run** named `AQUA Policy Verification - Job` and `AQUA Policy Verification - Job Run`
267+
268+
**Examples:**
269+
270+
```bash
271+
ads aqua verify_policies finetune
272+
```
273+
or
274+
```bash
275+
ads aqua verify_policies finetune --bucket fine-tune-data --ignore_subnet
276+
```
277+
or
278+
```bash
279+
ads aqua verify_policies finetune --bucket fine-tune-data --subnet_id ocid1.subnet.oc1..examplesubnetID
280+
```
281+
124282
- [Home](../README.md)
125283
- [CLI](../cli-tips.md)
126284
- [Model Deployment](../model-deployment-tips.md)

0 commit comments

Comments
 (0)