Skip to content

Commit be466b6

Browse files
authored
Update README.md
Added services used, updated readme with new libraries used
1 parent b8d3c33 commit be466b6

File tree

1 file changed

+25
-31
lines changed

1 file changed

+25
-31
lines changed

README.md

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,19 @@ This guidance will:
5959

6060
### AWS Services in this Guidance
6161

62-
**TO DO: Update list of services to the actually used in the guidance**
63-
64-
| **AWS Service** | Role | |
65-
| ------------------------------------------------------------------------ | ---- | ------------------------------------------------------------- |
66-
| [Amazon Transcribe](https://aws.amazon.com/transcribe/) | Core | Convert user speech to text. |
67-
| [Amazon Bedrock](https://aws.amazon.com/bedrock/) | Core | Invoke foundation model to translate natural language to ASL. |
68-
| [Amazon API Gateway](https://aws.amazon.com/api-gateway/) | Core | Create API to invoke lambda functions from user interface. |
69-
| [AWS Lambda](https://aws.amazon.com/lambda/) | Core | Run custom code to generate ASL for simplified text. |
70-
| [Amazon Cognito](https://aws.amazon.com/pm/cognito/) | Core | Authenticate user to access ASL translator |
71-
| [Amazon Comprehend](https://aws.amazon.com/comprehend/) | Core | Run moderation to detect toxicity on generated text |
72-
| [Amazon Rekognition](https://aws.amazon.com/rekognition/) | Core | Run moderation to detect toxicity on generated image |
73-
| [Amazon CloudFront](https://aws.amazon.com/cloudfront/) | Core | Fast and secure web-hosted user experience |
74-
| [Amazon Simple Storage Service (S3)](https://aws.amazon.com/pm/serv-s3/) | Core | Host user interface code, store generated images |
75-
| [Amazon Simple Notification Service (SNS)](https://aws.amazon.com/sns/) | Core | Send the notification to Unreal Engine |
76-
| [Amazon Simple Queue Service (SQS)](https://aws.amazon.com/sqs/) | Core | Queue notifications for Unreal Engine to consume |
62+
| **AWS Service** | Role | |
63+
| -----------------------------------------------------------------------------------| ---- | -------------------------------------------------------------------------------------------------|
64+
| [Amazon Simple Storage Service (S3)](https://aws.amazon.com/pm/serv-s3/) | Core | Host training models, job configurations, media, and generated assets |
65+
| [AWS Lambda](https://aws.amazon.com/lambda/) | Core | Run custom code to process requests |
66+
| [Amazon Simple Notification Service (SNS)](https://aws.amazon.com/sns/) | Core | Send completion status via notification to email |
67+
| [AWS Step Functions](https://aws.amazon.com/step-functions/) | Core | Orchestrate the 3D reconstruction workflow |
68+
| [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) | Core | Store training job details and attributes |
69+
| [Amazon SageMaker](https://aws.amazon.com/sagemaker/) | Core | Run 3D reconstruction pipeline processing on container |
70+
| [Amazon Elastic Container Registry](https://aws.amazon.com/ecr/) | Core | Image store for the custom created container |
71+
| [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/) | Core | Monitor logs and surface errors to SNS |
72+
| [AWS Identity and Access Management](https://aws.amazon.com/iam/) | Core | Security access controls to run the workflow securely |
73+
| [AWS Cloud Development Kit](https://aws.amazon.com/cdk/) | Core | Cloud infrastructure as code for easy deployment |
74+
| [Amazon Systems Manager Parameter Store](https://aws.amazon.com/systems-manager/) | Core | Securely store infrastructure resource ids in Parameter Store to aid in deployment and execution |
7775

7876
### Custom GS Pipeline Container
7977

@@ -86,27 +84,32 @@ In this project, there is only one Docker container that contains all of the 3D
8684
- [gsplat](https://github.com/nerfstudio-project/gsplat) [(Apache-2.0)](https://github.com/nerfstudio-project/gsplat?tab=Apache-2.0-1-ov-file#readme)
8785
- [backgroundremover](https://github.com/nadermx/backgroundremover) [(MIT)](https://github.com/nadermx/backgroundremover?tab=MIT-1-ov-file#readme)
8886
- [splatfacto-w](https://github.com/KevinXu02/splatfacto-w) [(Apache-2.0)](https://github.com/KevinXu02/splatfacto-w?tab=Apache-2.0-1-ov-file#readme)
87+
- [sam2](https://github.com/facebookresearch/sam2) [(Apache-2.0/BSD-3-Clause)](https://github.com/facebookresearch/sam2/blob/main/LICENSE)
88+
- [3DGRUT](https://github.com/nv-tlabs/3dgrut) [(Apache-2.0)](https://github.com/nv-tlabs/3dgrut#Apache-2.0-1-ov-file)
8989

9090
## Prerequisites
9191

9292
### Third-party tools
9393

94+
- Git
9495
- Docker
96+
- Terraform (if chosing not to deploy infrastructure using CDK)
9597

9698
### AWS account requirements
9799

98100
An active AWS Account with IAM user or role with elevated permissions to deploy resources is required to deploy this guidance, along with either a local computer with appropriate AWS credentials to deploy the CDK or Terraform solution, or utilize an AWS EC2 workstation to build and deploy the CDK or Terraform solution. Instructions for doing this will be in the [Implementation Guide](https://implementationguides.kits.eventoutfitters.aws.dev/open-3drt-0403/compute/open-source-3d-reconstruction-toolbox-for-gaussian-splats-on-aws.html)
99101

100102
Resources included in this deployment:
101103

102-
- EC2
103-
- VPC
104+
- EC2 (if chosing not to deploy infrastructure from your local computer)
104105
- IAM roles with permissions
105106
- CloudFormation
106-
- ECR
107-
- S3
108-
- SageMakerTraining Jobs
109-
- Stepfunctions
107+
- ECR Image
108+
- S3 Buckets
109+
- DynamoDB Table
110+
- Lambda Functions
111+
- SageMaker Training Jobs
112+
- Stepfunctions State Machine
110113
- CDK (bootstrap instructions will be included in the [Implementation Guide](https://implementationguides.kits.eventoutfitters.aws.dev/open-3drt-0403/compute/open-source-3d-reconstruction-toolbox-for-gaussian-splats-on-aws.html))
111114

112115
### Service limits
@@ -130,21 +133,12 @@ Resources included in this deployment:
130133
131134
## Cost
132135

133-
This section is for a high-level cost estimate. Think of a likely straightforward scenario with reasonable assumptions based on the problem the Guidance is trying to solve. Provide an in-depth cost breakdown table in this section below ( you should use AWS Pricing Calculator to generate cost breakdown ).
136+
_You are responsible for the cost of the AWS services used while running this Guidance. As of May 2025, the cost for running this Guidance with the default settings in the default AWS Region (US East 1(N. Virginia)) is approximately $278.33 per month for processing 100 requests._
134137

135-
Start this section with the following boilerplate text:
136-
137-
_You are responsible for the cost of the AWS services used while running this Guidance. As of <month> <year>, the cost for running this Guidance with the default settings in the <Default AWS Region (Most likely will be US East (N. Virginia)) > is approximately $<n.nn> per month for processing ( <nnnnn> records )._
138-
139-
Replace this amount with the approximate cost for running your Guidance in the default Region. This estimate should be per month and for processing/serving resonable number of requests/entities.
140-
141-
Suggest you keep this boilerplate text:
142138
_We recommend creating a [Budget](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) through [AWS Cost Explorer](https://aws.amazon.com/aws-cost-management/aws-cost-explorer/) to help manage costs. Prices are subject to change. For full details, refer to the pricing webpage for each AWS service used in this Guidance._
143139

144140
### Cost Table
145141

146-
**Note : Once you have created a sample cost table using AWS Pricing Calculator, copy the cost breakdown to below table and upload a PDF of the cost estimation on BuilderSpace. Do not add the link to the pricing calculator in the ReadMe.**
147-
148142
The following table provides a sample cost breakdown for deploying this Guidance with the default parameters in the US East (N. Virginia) Region for one month.
149143

150144
| AWS Service | Dimensions | Cost [USD] |

0 commit comments

Comments
 (0)