mirror of
https://github.com/hoshikawa2/mdm_project.git
synced 2026-03-03 16:09:37 +00:00
first commit
This commit is contained in:
12
.idea/.gitignore
generated
vendored
Normal file
12
.idea/.gitignore
generated
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
# Default ignored files
|
||||
/shelf/
|
||||
/workspace.xml
|
||||
# Editor-based HTTP Client requests
|
||||
/httpRequests/
|
||||
# Environment-dependent path to Maven home directory
|
||||
/mavenHomeManager.xml
|
||||
# Datasource local storage ignored files
|
||||
/dataSources/
|
||||
/dataSources.local.xml
|
||||
# Zeppelin ignored files
|
||||
/ZeppelinRemoteNotebooks/
|
||||
7
.idea/codeStyles/Project.xml
generated
Normal file
7
.idea/codeStyles/Project.xml
generated
Normal file
@@ -0,0 +1,7 @@
|
||||
<component name="ProjectCodeStyleConfiguration">
|
||||
<code_scheme name="Project" version="173">
|
||||
<ScalaCodeStyleSettings>
|
||||
<option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true" />
|
||||
</ScalaCodeStyleSettings>
|
||||
</code_scheme>
|
||||
</component>
|
||||
5
.idea/codeStyles/codeStyleConfig.xml
generated
Normal file
5
.idea/codeStyles/codeStyleConfig.xml
generated
Normal file
@@ -0,0 +1,5 @@
|
||||
<component name="ProjectCodeStyleConfiguration">
|
||||
<state>
|
||||
<option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
|
||||
</state>
|
||||
</component>
|
||||
9
.idea/mdm_project.iml
generated
Normal file
9
.idea/mdm_project.iml
generated
Normal file
@@ -0,0 +1,9 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module type="JAVA_MODULE" version="4">
|
||||
<component name="NewModuleRootManager" inherit-compiler-output="true">
|
||||
<exclude-output />
|
||||
<content url="file://$MODULE_DIR$" />
|
||||
<orderEntry type="inheritedJdk" />
|
||||
<orderEntry type="sourceFolder" forTests="false" />
|
||||
</component>
|
||||
</module>
|
||||
6
.idea/misc.xml
generated
Normal file
6
.idea/misc.xml
generated
Normal file
@@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="graalvm-jdk-17" project-jdk-type="JavaSDK">
|
||||
<output url="file://$PROJECT_DIR$/out" />
|
||||
</component>
|
||||
</project>
|
||||
8
.idea/modules.xml
generated
Normal file
8
.idea/modules.xml
generated
Normal file
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="ProjectModuleManager">
|
||||
<modules>
|
||||
<module fileurl="file://$PROJECT_DIR$/.idea/mdm_project.iml" filepath="$PROJECT_DIR$/.idea/mdm_project.iml" />
|
||||
</modules>
|
||||
</component>
|
||||
</project>
|
||||
6
.idea/vcs.xml
generated
Normal file
6
.idea/vcs.xml
generated
Normal file
@@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings">
|
||||
<mapping directory="" vcs="Git" />
|
||||
</component>
|
||||
</project>
|
||||
24
.oca/custom_code_review_guidelines.txt
Normal file
24
.oca/custom_code_review_guidelines.txt
Normal file
@@ -0,0 +1,24 @@
|
||||
# Sample guideline, please follow similar structure for guideline with code samples
|
||||
# 1. Suggest using streams instead of simple loops for better readability.
|
||||
# <example>
|
||||
# *Comment:
|
||||
# Category: Minor
|
||||
# Issue: Use streams instead of a loop for better readability.
|
||||
# Code Block:
|
||||
#
|
||||
# ```java
|
||||
# // Calculate squares of numbers
|
||||
# List<Integer> squares = new ArrayList<>();
|
||||
# for (int number : numbers) {
|
||||
# squares.add(number * number);
|
||||
# }
|
||||
# ```
|
||||
# Recommendation:
|
||||
#
|
||||
# ```java
|
||||
# // Calculate squares of numbers
|
||||
# List<Integer> squares = Arrays.stream(numbers)
|
||||
# .map(n -> n * n) // Map each number to its square
|
||||
# .toList();
|
||||
# ```
|
||||
# </example>
|
||||
166
README.md
Normal file
166
README.md
Normal file
@@ -0,0 +1,166 @@
|
||||
|
||||
# Master Data Management (MDM) Project Deployment Guide
|
||||
|
||||
## 1. Introduction
|
||||
|
||||
This project implements a **Master Data Management (MDM) pipeline** powered by **AI agents** and **GPU acceleration**.
|
||||
Its purpose is to **normalize, validate, deduplicate, harmonize, and enrich master records** across multiple domains, such as:
|
||||
|
||||
- **Customer records** (names, phone numbers, emails, addresses, etc.)
|
||||
- **Product data** (SKU, EAN, units, volumes, etc.)
|
||||
- **Supplier information** (legal entities, CNPJs, contact data)
|
||||
- **Financial data** (transaction codes, normalization rules)
|
||||
- **Address standardization** (postal codes, neighborhoods, city/state consistency)
|
||||
|
||||
### Example Use Cases
|
||||
- Consolidating duplicated **customer profiles** coming from multiple systems (CRM, ERP, Mobile App).
|
||||
- **Normalizing Brazilian addresses** with CEP validation via **ZipCodeBase API**.
|
||||
- Formatting **CPF, CNPJ, and phone numbers** into consistent formats.
|
||||
- Enriching records with **external data sources** (postal APIs, product catalogs).
|
||||
|
||||
### Infrastructure
|
||||
This deployment is designed for **NVIDIA A10 GPU instances** on **Oracle Cloud Infrastructure (OCI)**.
|
||||
OCI provides **specialized GPU compute shapes** that are CUDA-enabled, allowing high performance for **large language models (LLMs)** and **parallel inference workloads**.
|
||||
|
||||
The system leverages **CUDA acceleration** to maximize throughput and process large amounts of records efficiently, distributing the workload across multiple GPU endpoints.
|
||||
|
||||
---
|
||||
|
||||
## 2. Prerequisites
|
||||
|
||||
### Hardware
|
||||
- **GPU**: NVIDIA A10 or higher (OCI `VM.GPU.A10.1` or `BM.GPU.A10.4`).
|
||||
- **vCPUs**: Minimum 16 cores.
|
||||
- **RAM**: Minimum 64 GB.
|
||||
- **Disk**: At least 200 GB SSD (recommended NVMe).
|
||||
|
||||
### Software
|
||||
- **Operating System**: Oracle Linux 8 or Ubuntu 22.04.
|
||||
- **CUDA Toolkit**: Version 12.2+ with NVIDIA drivers installed.
|
||||
- **Python**: Version 3.10 or higher.
|
||||
- **Ollama**: Serving local LLMs in GGUF format.
|
||||
- **Conda Environment**:
|
||||
```bash
|
||||
conda create -n mdm python=3.10 -y
|
||||
conda activate mdm
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Required Python Packages
|
||||
- `fastapi`
|
||||
- `uvicorn`
|
||||
- `httpx`
|
||||
- `pydantic`
|
||||
- `orjson`
|
||||
- `rake-nltk`
|
||||
- `regex`
|
||||
- `numpy`
|
||||
|
||||
### External Services
|
||||
- **ZipCodeBase API key** for address enrichment.
|
||||
- Access to **OCI tenancy** with GPU compute shapes enabled.
|
||||
|
||||
---
|
||||
|
||||
## 3. Understand the Architecture
|
||||
|
||||
The project follows a **modular architecture** with clear separation of responsibilities.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[Input Records] --> B[FastAPI App - mdm_app]
|
||||
B --> C[Normalize Service]
|
||||
B --> D[Validate Service]
|
||||
B --> E[Deduplication Service]
|
||||
B --> F[Address Parser Service]
|
||||
B --> G[ZipCodeBase Enrichment]
|
||||
|
||||
C --> H[(Ollama GPU - CUDA A10)]
|
||||
D --> H
|
||||
E --> H
|
||||
F --> H
|
||||
|
||||
G --> I[(ZipCodeBase API)]
|
||||
H --> J[Golden Record Consolidation]
|
||||
|
||||
J --> K[Output JSON Results]
|
||||
```
|
||||
|
||||
### Module Responsibilities
|
||||
- **FastAPI App**: Orchestrates API requests and workflows.
|
||||
- **Normalize Service**: Uses LLM to reformat CPF, CNPJ, phone, and names.
|
||||
- **Validate Service**: Ensures compliance with domain-specific rules.
|
||||
- **Deduplication Service**: Detects and merges duplicate records.
|
||||
- **Address Parser Service**: Extracts structured components (street, city, neighborhood, state).
|
||||
- **ZipCodeBase Enrichment**: Complements address data with official postal information.
|
||||
- **Golden Record Consolidation**: Produces a unified, conflict-free record.
|
||||
|
||||
---
|
||||
|
||||
## 4. Deploy the Application
|
||||
|
||||
### Step 1 — Prepare Environment
|
||||
```bash
|
||||
git clone https://github.com/your-org/mdm-server.git
|
||||
cd mdm-server
|
||||
conda activate mdm
|
||||
```
|
||||
|
||||
### Step 2 — Configure Environment Variables
|
||||
Create a `.env` file:
|
||||
```bash
|
||||
REQUEST_TIMEOUT=300
|
||||
OLLAMA_ENDPOINTS="http://127.0.0.1:11434,http://127.0.0.1:11435"
|
||||
NUM_GPU=2000
|
||||
NUM_BATCH=512
|
||||
NUM_CTX=8192
|
||||
NUM_THREAD=512
|
||||
CONCURRENCY_NORMALIZE=16
|
||||
CONCURRENCY_ADDRESS=16
|
||||
ZIPCODEBASE_KEY=your_api_key_here
|
||||
```
|
||||
|
||||
### Step 3 — Launch Ollama GPU Servers
|
||||
```bash
|
||||
CUDA_VISIBLE_DEVICES=0 OLLAMA_HOST=127.0.0.1:11434 ollama serve
|
||||
CUDA_VISIBLE_DEVICES=1 OLLAMA_HOST=127.0.0.1:11435 ollama serve
|
||||
```
|
||||
|
||||
### Step 4 — Run FastAPI Application
|
||||
```bash
|
||||
uvicorn mdm_app.app:app --host 0.0.0.0 --port 8080 --workers 4
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Test
|
||||
|
||||
### Send a Test Request
|
||||
```bash
|
||||
curl -X POST http://localhost:8080/mdm/process -H "Content-Type: application/json" -d '{
|
||||
"domain": "customer",
|
||||
"operations": ["normalize", "validate", "dedupe", "consolidate"],
|
||||
"records": [
|
||||
{
|
||||
"source": "CRM",
|
||||
"id": "cust-1001",
|
||||
"name": "Ana Paula",
|
||||
"cpf": "98765432100",
|
||||
"phone": "21988887777",
|
||||
"cep": "22041001",
|
||||
"address": "Rua Figueiredo Magalhaes, 123"
|
||||
}
|
||||
]
|
||||
}'
|
||||
```
|
||||
|
||||
### Expected Output
|
||||
- **CPF** formatted as `987.654.321-00`.
|
||||
- **Phone** formatted as `+55 21 98888-7777`.
|
||||
- **CEP** formatted as `22041-001`.
|
||||
- **Address enriched** with neighborhood `Copacabana`, city `Rio de Janeiro`, state `RJ`.
|
||||
- **Golden record** returned with deduplication applied.
|
||||
|
||||
---
|
||||
|
||||
✅ At this point, the project should be fully deployed, running on **OCI A10 GPUs**, and producing clean, standardized, and enriched master data records.
|
||||
Reference in New Issue
Block a user