eda-franky-v1 / README.md
architojha's picture
pushing api
8675ade
|
raw
history blame
4.16 kB

Franky EDA Engine

Project Structure

FRANKY-API/
β”œβ”€β”€ knowledge_base/
β”‚   β”œβ”€β”€ raw/
β”‚   └── vector/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ api/
β”‚   β”‚    β”œβ”€β”€ v1/
β”‚   β”‚    β”‚    β”œβ”€β”€ build_ml_plan/
β”‚   β”‚    β”‚    β”‚      β”œβ”€β”€ __init__.py
β”‚   β”‚    β”‚    β”‚      β”œβ”€β”€ eda.py
β”‚   β”‚    β”‚    β”‚      └── task_analysis.py
β”‚   β”‚    β”‚    β”œβ”€β”€ eda_engine/
β”‚   β”‚    β”‚    β”‚      β”œβ”€β”€ __init__.py
β”‚   β”‚    β”‚    β”‚      β”œβ”€β”€ data_quality.py
β”‚   β”‚    β”‚    β”‚      β”œβ”€β”€ data_statistics.py
β”‚   β”‚    β”‚    β”‚      β”œβ”€β”€ data_understanding.py
β”‚   β”‚    β”‚    β”‚      └── univariate_analysis.py
β”‚   β”‚    β”‚    └── __init__.py
β”‚   β”‚    └── __init__.py
β”‚   β”œβ”€β”€ app/
β”‚   β”‚    β”œβ”€β”€ pipelines/
β”‚   β”‚    β”‚     β”œβ”€β”€ eda/
β”‚   β”‚    β”‚     β”‚     β”œβ”€β”€ agemts/
β”‚   β”‚    β”‚     β”‚     β”‚      β”œβ”€β”€ agents.py
β”‚   β”‚    β”‚     β”‚     β”‚      β”œβ”€β”€ models.py
β”‚   β”‚    β”‚     β”‚     β”‚      └── prompts.py
β”‚   β”‚    β”‚     β”‚     β”œβ”€β”€ tools/
β”‚   β”‚    β”‚     β”‚     β”‚      β”œβ”€β”€ analysis_tools/
β”‚   β”‚    β”‚     β”‚     β”‚      β”‚      β”œβ”€β”€ __init__.py
β”‚   β”‚    β”‚     β”‚     β”‚      β”‚      β”œβ”€β”€ bivariate_analysis.py
β”‚   β”‚    β”‚     β”‚     β”‚      β”‚      β”œβ”€β”€ multivariate_analysis.py
β”‚   β”‚    β”‚     β”‚     β”‚      β”‚      └── univariate_analysis.py
β”‚   β”‚    β”‚     β”‚     β”‚      β”œβ”€β”€ data_cleaning_tools/
β”‚   β”‚    β”‚     β”‚     β”‚      β”‚      β”œβ”€β”€ __init__.py
β”‚   β”‚    β”‚     β”‚     β”‚      β”‚      β”œβ”€β”€ handle_missing_values.py
β”‚   β”‚    β”‚     β”‚     β”‚      β”‚      └── handle_outliers.py
β”‚   β”‚    β”‚     β”‚     β”‚      β”œβ”€β”€ transformations_tools/
β”‚   β”‚    β”‚     β”‚     β”‚      └── lib.py
β”‚   β”‚    β”‚     β”‚     β”œβ”€β”€ helper.py
β”‚   β”‚    β”‚     β”‚     β”œβ”€β”€ model.py
β”‚   β”‚    β”‚     β”‚     └── pipeline.py
β”‚   β”‚    β”‚     β”œβ”€β”€ modules/
β”‚   β”‚    β”‚     β”‚     β”œβ”€β”€ __init__.py
β”‚   β”‚    β”‚     β”‚     β”œβ”€β”€ data_quality_assessment.py
β”‚   β”‚    β”‚     β”‚     β”œβ”€β”€ data_statistics.py
β”‚   β”‚    β”‚     β”‚     β”œβ”€β”€ data_understanding_context.py
β”‚   β”‚    β”‚     β”‚     └── univariate_analysis.py
β”‚   β”‚    β”‚     └── task_analysis/
β”‚   β”‚    β”‚           β”œβ”€β”€ __init__.py
β”‚   β”‚    β”‚           β”œβ”€β”€ ml_analysis_workflow.py
β”‚   β”‚    β”‚           β”œβ”€β”€ ml_implementation_planner_workflow.py
β”‚   β”‚    β”‚           └── model.py
β”‚   β”‚    └── schemas/
β”‚   β”‚          β”œβ”€β”€ requests/
β”‚   β”‚          β”‚      β”œβ”€β”€ __init__.py
β”‚   β”‚          β”‚      β”œβ”€β”€ eda.py
β”‚   β”‚          β”‚      └── task_analysis.py
β”‚   β”‚          └── responses/
β”‚   β”‚                 └── eda.py
β”‚   └── core/
β”‚        β”œβ”€β”€ cache/
β”‚        β”‚      β”œβ”€β”€ code_generated/
β”‚        β”‚      β”œβ”€β”€ dataset_logs/
β”‚        β”‚      β”œβ”€β”€ downloads/
β”‚        β”‚      └── redis_cache.py
β”‚        β”œβ”€β”€ database/
β”‚        β”œβ”€β”€ logs/
β”‚        β”œβ”€β”€ utils/
β”‚        β”‚      β”œβ”€β”€ __init__.py
β”‚        β”‚      β”œβ”€β”€ knowledge_base.py
β”‚        β”‚      β”œβ”€β”€ logger.py
β”‚        β”‚      β”œβ”€β”€ prompts.py
β”‚        β”‚      └── read_config.py
β”‚        └── server.py
β”œβ”€β”€ .env.template
β”œβ”€β”€ .gitignore
β”œβ”€β”€ config.yaml
β”œβ”€β”€ Dockerfile
β”œβ”€β”€ main.py
β”œβ”€β”€ prepare_kb.py
β”œβ”€β”€ README.md
└── Dockerfile

Getting Started

1. Clone the Repository

2. Running the Docker Container

To build the docker image, run the following cmd:

docker build -t franky-api .

To run the docker container, run the following cmd:

docker run -d -p 8000:8000 --name franky-api-container franky-api

You can access the api at:

http://localhost:8000/