architojha commited on
Commit
6c6841f
Β·
1 Parent(s): 8675ade

fixed readme

Browse files
Files changed (1) hide show
  1. README.md +10 -111
README.md CHANGED
@@ -1,111 +1,10 @@
1
- # Franky EDA Engine
2
-
3
- ## Project Structure
4
-
5
- ```plaintext
6
- FRANKY-API/
7
- β”œβ”€β”€ knowledge_base/
8
- β”‚ β”œβ”€β”€ raw/
9
- β”‚ └── vector/
10
- β”œβ”€β”€ src/
11
- β”‚ β”œβ”€β”€ api/
12
- β”‚ β”‚ β”œβ”€β”€ v1/
13
- β”‚ β”‚ β”‚ β”œβ”€β”€ build_ml_plan/
14
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py
15
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ eda.py
16
- β”‚ β”‚ β”‚ β”‚ └── task_analysis.py
17
- β”‚ β”‚ β”‚ β”œβ”€β”€ eda_engine/
18
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py
19
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ data_quality.py
20
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ data_statistics.py
21
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ data_understanding.py
22
- β”‚ β”‚ β”‚ β”‚ └── univariate_analysis.py
23
- β”‚ β”‚ β”‚ └── __init__.py
24
- β”‚ β”‚ └── __init__.py
25
- β”‚ β”œβ”€β”€ app/
26
- β”‚ β”‚ β”œβ”€β”€ pipelines/
27
- β”‚ β”‚ β”‚ β”œβ”€β”€ eda/
28
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ agemts/
29
- β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ agents.py
30
- β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ models.py
31
- β”‚ β”‚ β”‚ β”‚ β”‚ └── prompts.py
32
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ tools/
33
- β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ analysis_tools/
34
- β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py
35
- β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ bivariate_analysis.py
36
- β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ multivariate_analysis.py
37
- β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── univariate_analysis.py
38
- β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ data_cleaning_tools/
39
- β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py
40
- β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ handle_missing_values.py
41
- β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── handle_outliers.py
42
- β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ transformations_tools/
43
- β”‚ β”‚ β”‚ β”‚ β”‚ └── lib.py
44
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ helper.py
45
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ model.py
46
- β”‚ β”‚ β”‚ β”‚ └── pipeline.py
47
- β”‚ β”‚ β”‚ β”œβ”€β”€ modules/
48
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py
49
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ data_quality_assessment.py
50
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ data_statistics.py
51
- β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ data_understanding_context.py
52
- β”‚ β”‚ β”‚ β”‚ └── univariate_analysis.py
53
- β”‚ β”‚ β”‚ └── task_analysis/
54
- β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py
55
- β”‚ β”‚ β”‚ β”œβ”€β”€ ml_analysis_workflow.py
56
- β”‚ β”‚ β”‚ β”œβ”€β”€ ml_implementation_planner_workflow.py
57
- β”‚ β”‚ β”‚ └── model.py
58
- β”‚ β”‚ └── schemas/
59
- β”‚ β”‚ β”œβ”€β”€ requests/
60
- β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py
61
- β”‚ β”‚ β”‚ β”œβ”€β”€ eda.py
62
- β”‚ β”‚ β”‚ └── task_analysis.py
63
- β”‚ β”‚ └── responses/
64
- β”‚ β”‚ └── eda.py
65
- β”‚ └── core/
66
- β”‚ β”œβ”€β”€ cache/
67
- β”‚ β”‚ β”œβ”€β”€ code_generated/
68
- β”‚ β”‚ β”œβ”€β”€ dataset_logs/
69
- β”‚ β”‚ β”œβ”€β”€ downloads/
70
- β”‚ β”‚ └── redis_cache.py
71
- β”‚ β”œβ”€β”€ database/
72
- β”‚ β”œβ”€β”€ logs/
73
- β”‚ β”œβ”€β”€ utils/
74
- β”‚ β”‚ β”œβ”€β”€ __init__.py
75
- β”‚ β”‚ β”œβ”€β”€ knowledge_base.py
76
- β”‚ β”‚ β”œβ”€β”€ logger.py
77
- β”‚ β”‚ β”œβ”€β”€ prompts.py
78
- β”‚ β”‚ └── read_config.py
79
- β”‚ └── server.py
80
- β”œβ”€β”€ .env.template
81
- β”œβ”€β”€ .gitignore
82
- β”œβ”€β”€ config.yaml
83
- β”œβ”€β”€ Dockerfile
84
- β”œβ”€β”€ main.py
85
- β”œβ”€β”€ prepare_kb.py
86
- β”œβ”€β”€ README.md
87
- └── Dockerfile
88
- ```
89
-
90
- ## Getting Started
91
-
92
- ### 1. Clone the Repository
93
-
94
- ### 2. Running the Docker Container
95
-
96
- To build the docker image, run the following cmd:
97
-
98
- ```bash
99
- docker build -t franky-api .
100
- ```
101
-
102
- To run the docker container, run the following cmd:
103
-
104
- ```bash
105
- docker run -d -p 8000:8000 --name franky-api-container franky-api
106
- ```
107
-
108
- You can access the api at:
109
-
110
- [http://localhost:8000/](http://localhost:8000/docs)
111
-
 
1
+ ---
2
+ title: Eda Franky V1
3
+ emoji: πŸ“Š
4
+ colorFrom: green
5
+ colorTo: gray
6
+ sdk: docker
7
+ pinned: false
8
+ ---
9
+
10
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference