Skip to content
This repository was archived by the owner on Dec 30, 2024. It is now read-only.

Commit 1c28aa2

Browse files
committed
update tree folder for the new release
1 parent 6e95aa5 commit 1c28aa2

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ The solution automates digital asset (text and image) ingestion from twitter, RS
66

77
The solution performs the following key features:
88

9-
- **Performs topic modeling to detect dominant topics**: identifies the terms that collectively form a topic from within customer feedback
10-
- **Identifies the sentiment of what customers are saying**: uses contextual semantic search to understand the nature of online discussions
11-
- **Determines if images associated with your brand contain unsafe content**: detects unsafe and negative imagery in content
12-
- **Helps customers identify insights in near real-time**: you can use a visualization dashboard to better understand context, threats, and opportunities almost instantly
9+
- **Performs topic modeling to detect dominant topics**: identifies the terms that collectively form a topic from within customer feedback
10+
- **Identifies the sentiment of what customers are saying**: uses contextual semantic search to understand the nature of online discussions
11+
- **Determines if images associated with your brand contain unsafe content**: detects unsafe and negative imagery in content
12+
- **Helps customers identify insights in near real-time**: you can use a visualization dashboard to better understand context, threats, and opportunities almost instantly
1313

1414
This solution deploys an AWS CloudFormation template that supports Twitter, RSS feeds, and YouTube comments as data source options for ingestion, but the solution can be customized to aggregate other social media platforms and internal enterprise systems.
1515

1616
For a detailed solution deployment guide, refer to [Discovering Hot Topics using Machine Learning](https://aws.amazon.com/solutions/implementations/discovering-hot-topics-using-machine-learning)
1717

1818
## On this Page
1919

20-
- [Architecture Overview](#architecture-overview)
21-
- [Deployment](#deployment)
22-
- [Source Code](#source-code)
23-
- [Creating a custom build](#creating-a-custom-build)
20+
- [Architecture Overview](#architecture-overview)
21+
- [Deployment](#deployment)
22+
- [Source Code](#source-code)
23+
- [Creating a custom build](#creating-a-custom-build)
2424

2525
## Architecture Overview
2626

@@ -54,13 +54,13 @@ After you deploy the solution, use the included Amazon QuickSight dashboard to v
5454

5555
[AWS CDK Solutions Constructs](https://aws.amazon.com/solutions/constructs/) make it easier to consistently create well-architected applications. All AWS Solutions Constructs are reviewed by AWS and use best practices established by the AWS Well-Architected Framework. This solution uses the following AWS CDK Constructs:
5656

57-
- aws-events-rule-lambda
58-
- aws-kinesisfirehose-s3
59-
- aws-kinesisstreams-lambda
60-
- aws-lambda-dynamodb
61-
- aws-lambda-s3
62-
- aws-lambda-step-function
63-
- aws-sqs-lambda
57+
- aws-events-rule-lambda
58+
- aws-kinesisfirehose-s3
59+
- aws-kinesisstreams-lambda
60+
- aws-lambda-dynamodb
61+
- aws-lambda-s3
62+
- aws-lambda-step-function
63+
- aws-sqs-lambda
6464

6565
## Deployment
6666

@@ -78,12 +78,12 @@ The solution is deployed using a CloudFormation template with a lambda backed cu
7878
├── bin [entrypoint of the CDK application]
7979
├── lambda [folder containing source code the lambda functions]
8080
│ ├── capture_news_feed [lambda function to ingest news feeds]
81-
│ ├── create-partition [lambda function to create glue partitions]
8281
│   ├── firehose_topic_proxy [lambda function to write topic analysis output to Amazon Kinesis Firehose]
8382
│   ├── firehose-text-proxy [lambda function to write text analysis output to Amazon Kinesis Firehose]
84-
│   ├── ingestion-consumer [lambda function that consumes messages from Amazon Kinesis Data Stream]
83+
│   ├── ingestion-consumer [lambda function that consumes messages from Amazon Kinesis Data Streams]
84+
│   ├── ingestion-custom [lambda function that reads files from Amazon S3 bucket and pushes data to Amazon Kinesis Data Streams]
8585
│   ├── ingestion-producer [lambda function that makes Twitter API call and pushes data to Amazon Kinesis Data Stream]
86-
│   ├── ingestion-youtube [lambda function that ingests comments from YouTube videos and pushes data to Amazon Kinesis Data Stream]
86+
│   ├── ingestion-youtube [lambda function that ingests comments from YouTube videos and pushes data to Amazon Kinesis Data Streams]
8787
│   ├── integration [lambda function that publishes inference outputs to Amazon Events Bridge]
8888
│ ├── layers [lambda layer function library for Node and Python layers]
8989
│ │ ├── aws-nodesdk-custom-config
@@ -106,10 +106,12 @@ The solution is deployed using a CloudFormation template with a lambda backed cu
106106
│   ├── ingestion [CDK constructs for data ingestion]
107107
│   ├── integration [CDK constructs for Amazon Events Bridge]
108108
│ ├── quicksight-custom-resources [CDK construct that invokes custom resources to create Amazon QuickSight resources]
109+
│ ├── s3-event-notification [CDK construct that configures S3 events to be pushed to Amazon EventBridge]
109110
│   ├── storage [CDK constructs that define storage of the inference events]
110111
│   ├── text-analysis-workflow [CDK constructs for text analysis of ingested data]
111112
│   ├── topic-analysis-workflow [CDK constructs for topic visualization of ingested data]
112113
│   └── visualization [CDK constructs to build a relational database model for visualization]
114+
├── discovering-hot-topics.ts
113115
```
114116

115117
## Creating a custom build
@@ -124,22 +126,22 @@ Clone this git repository
124126

125127
### 2. Build the solution for deployment
126128

127-
- To run the unit tests
129+
- To run the unit tests
128130

129131
```
130132
cd <rootDir>/source
131133
chmod +x ./run-all-tests.sh
132134
./run-all-tests.sh
133135
```
134136

135-
- Configure the bucket name of your target Amazon S3 distribution bucket
137+
- Configure the bucket name of your target Amazon S3 distribution bucket
136138

137139
```
138140
export DIST_OUTPUT_BUCKET=my-bucket-name
139141
export VERSION=my-version
140142
```
141143

142-
- Now build the distributable:
144+
- Now build the distributable:
143145

144146
```
145147
cd <rootDir>/deployment
@@ -148,7 +150,7 @@ chmod +x ./build-s3-dist.sh
148150
149151
```
150152

151-
- Parameter details
153+
- Parameter details
152154

153155
```
154156
$DIST_OUTPUT_BUCKET - This is the global name of the distribution. For the bucket name, the AWS Region is added to the global name (example: 'my-bucket-name-us-east-1') to create a regional bucket. The lambda artifact should be uploaded to the regional buckets for the CloudFormation template to pick it up for deployment.
@@ -158,13 +160,13 @@ $CF_TEMPLATE_BUCKET_NAME - The name of the S3 bucket where the CloudFormation te
158160
$QS_TEMPLATE_ACCOUNT - The account from which the Amazon QuickSight templates should be sourced for Amazon QuickSight Analysis and Dashboard creation
159161
```
160162

161-
- When creating and using buckets it is recommeded to:
163+
- When creating and using buckets it is recommeded to:
162164

163-
- Use randomized names or uuid as part of your bucket naming strategy.
164-
- Ensure buckets are not public.
165-
- Verify bucket ownership prior to uploading templates or code artifacts.
165+
- Use randomized names or uuid as part of your bucket naming strategy.
166+
- Ensure buckets are not public.
167+
- Verify bucket ownership prior to uploading templates or code artifacts.
166168

167-
- Deploy the distributable to an Amazon S3 bucket in your account. _Note:_ you must have the AWS Command Line Interface installed.
169+
- Deploy the distributable to an Amazon S3 bucket in your account. _Note:_ you must have the AWS Command Line Interface installed.
168170

169171
```
170172
aws s3 cp ./global-s3-assets/ s3://my-bucket-name-<aws_region>/discovering-hot-topics-using-machine-learning/<my-version>/ --recursive --acl bucket-owner-full-control --profile aws-cred-profile-name

0 commit comments

Comments
 (0)