Update package structure

rmazzine · Sep 1, 2023 · 8fb8e6f · 8fb8e6f
1 parent 1e2a3cf
commit 8fb8e6f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ This package finds an optimal point (closer to the  input dataset point), which
 
 ### Minimal example:
 ```python
-from cfnow.cf_finder import find_tabular
+from cfnow import find_tabular
 import sklearn.datasets
 import sklearn.ensemble
 import pandas as pd
@@ -110,7 +110,7 @@ print(f"Factual: {x}\nFactual class: {model.predict([x])}")
 
 #### 2 - Find the CF
 ```python
-from cfnow.cf_finder import find_tabular
+from cfnow import find_tabular
 # Then, we use CFNOW to generate the minimum modification to change the classification
 cf_obj = find_tabular(
     factual=pd.Series(x),
@@ -165,7 +165,7 @@ print(f"Factual: {x.tolist()}\nFactual class: {model.predict([x])}")
 
 #### 2 - Find the CF
 ```python
-from cfnow.cf_finder import find_tabular
+from cfnow import find_tabular
 # Then, we use CFNOW to generate the minimum modification to change the classification
 cf_obj = find_tabular(
     factual=x,
@@ -218,7 +218,7 @@ print(f"Factual: {x.tolist()}\nFactual class: {model.predict([x])}")
 
 #### 2 - Find the CF
 ```python
-from cfnow.cf_finder import find_tabular
+from cfnow import find_tabular
 # Then, we use CFNOW to generate the minimum modification to change the classification
 cf_obj = find_tabular(
     factual=x,

diff --git a/cfnow/__init__.py b/cfnow/__init__.py
@@ -1,5 +1,7 @@
-from cfnow import cf_finder
+from cfnow.cf_finder import find_tabular, find_image, find_text
 
 __all__ = [
-    'cf_finder'
+    'find_tabular',
+    'find_image',
+    'find_text',
 ]