From 16fb6416e01aad2e22880d767d726fbad6160c36 Mon Sep 17 00:00:00 2001 From: Diego Arenas Date: Tue, 24 Dec 2024 10:05:32 +0100 Subject: [PATCH] Update documentation --- README.md | 8 ++++---- docs/index.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4173669..6226f54 100644 --- a/README.md +++ b/README.md @@ -46,14 +46,14 @@ TARGET_FOLDER = "" OUTPUT_FOLDER = "" # Run exploration on the files -df_files = afe.explore(TARGET_FOLDER) +df_files = afe.explore_files(TARGET_FOLDER) # Generate pandas code to load the files -afe.generate(df_files) +afe.generate_code(df_files) # Run profiling on each file -afe.profile(df_files, profile_tool="ydata-profiling", output_path=OUTPUT_FOLDER) -afe.profile(df_files, profile_tool="sweetviz", output_path=OUTPUT_FOLDER) +afe.profile_files(df_files, profile_tool="ydata-profiling", output_path=OUTPUT_FOLDER) +afe.profile_files(df_files, profile_tool="sweetviz", output_path=OUTPUT_FOLDER) ``` # What can you do with AFES diff --git a/docs/index.md b/docs/index.md index 11e0c32..ef106e7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,14 +43,14 @@ TARGET_FOLDER = "" OUTPUT_FOLDER = "" # Run exploration on the files -df_files = afe.explore(TARGET_FOLDER) +df_files = afe.explore_files(TARGET_FOLDER) # Generate pandas code to load the files -afe.generate(df_files) +afe.generate_code(df_files) # Run profiling on each file -afe.profile(df_files, profile_tool="ydata-profiling", output_path=OUTPUT_FOLDER) -afe.profile(df_files, profile_tool="sweetviz", output_path=OUTPUT_FOLDER) +afe.profile_files(df_files, profile_tool="ydata-profiling", output_path=OUTPUT_FOLDER) +afe.profile_files(df_files, profile_tool="sweetviz", output_path=OUTPUT_FOLDER) ``` # What can you do with AFES