Skip to content

Commit

Permalink
add instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
badra001 committed Jun 22, 2026
1 parent d62e020 commit 8b0a362
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 3 deletions.
60 changes: 58 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,62 @@
## AI Inventory Details

* [Inventory Catalog](inventory/catalog.md)
* [Inventory Markdown](https://github.e.it.census.gov/terraform/cloud-information/blob/master/aws/documentation/services/bedrock/inventory.md)
* [Inventory YAML](https://github.e.it.census.gov/terraform/cloud-information/blob/master/aws/documentation/services/bedrock/inventory.yml)
* [Inventory Markdown](inventory/inventory.md)
* [Inventory YAML](inventory/inventory.yml)

## How to Submit a Request

For each new request, please pull the latest inventory detail file above. We prefer the YAML file, as that is used directly
by catalog generation scripts.

### 1. Version

Leave this section alone, it indicates the version of the collection template.

### 2. Links

This is informational in the markdown, and does not exist in the YAML file. You may leave this section alone.

### 3. Basic Information

Enter the name, division abbreviation and email address for each contact.

### 4. Bdrock Requestred Information

* You can leave the first 3 items alone (company name, website, industry) as those will not change.
* Select the intended users (internal, external, or both).
* Add a short description of the use case(s). This will be submitted to AWS when we enable the model(s) access.
A longer description will be entered later.
* Select the specifc model(s) you wish to use. Do not add any to this list, as what we show in the selection list
are the only ones available to us at the time. If the comments say it cannot be eanbled or is not available, do not
select it.

### 5. Federal Standards Requested Information

* We will assign an ID.
* Enter the project name, and the associated acronym or abbreviation.
* Enter a longer project summary.
* Select your development stage from one of the listed options
* Answer the data sensitivity question and select which type of data
* Enter the CMS or DMS project number, if applicable
* If it is a CMS or DMS project, enter the start and end dates of the project (from CMS or DMS)

### 6. Deployment Details

* List your AWS account(s) where you want to use this. The ID is a 12 digit number and the alias is someting like `edl-addcp-dev-gov`.
* Select the region(s) you wish to use. If your workload is only in one region, select that region only.
* Enter the CSVD CRF number, if applicable
* Enter the FinOps project number (fs00...x)
* Enter the FinOps project name

### 7. Changelog/History

Leave these sections alone. The markdown shows the template changelog, and the YAML has a placeholder for such a thing.

### Submit to OIS

Send the resultant YAML or Markdown to OIS (Rodney Dubose, rodney.anthony.dubose@census.gov) who will look it over, make comments,
and drop it into a `requests/` directory in the AI Inventory repository. He will then make a pull request (PR) for further
comments and/or processing.


4 changes: 3 additions & 1 deletion inventory.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,11 @@ and then submit a PR to have it configured and addressed.
* Planned, Research, Pilot, Active, or Retired
1. Data Sensitivity
* Does the system process PII or other Sensitive data?
* If so, what type(s)
* What type(s) of data
- [ ] Title 5/PII
- [ ] Title 13
- [ ] Title 26
- [ ] pseudo or synthetic data
- [ ] Others (describe types)
1. DMS or CMS Project Number
* if applicable
Expand Down Expand Up @@ -104,3 +105,4 @@ and then submit a PR to have it configured and addressed.
- amazon.titan-text-lite
- 1.0.5 -- 2026-06-22
- update to be consistent with yml file
- add pseudo/synthentic data option
1 change: 1 addition & 0 deletions inventory.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ federal_standards_information:
- title5_pii
- title13
- title26
- pseudo_or_synthetic
- other (specify)
dms_project_NUMBER: NUMBER
cms_project_NUMBER: NUMBER
Expand Down

0 comments on commit 8b0a362

Please sign in to comment.