Merge branch 'doc/update' into dev

AlexandreGazagnes · Feb 8, 2024 · af112ca · af112ca
2 parents c1df48d + 512c1c6
commit af112ca
Show file tree

Hide file tree

Showing 26 changed files with 5,426 additions and 71 deletions.
diff --git a/README.md b/README.md
@@ -34,8 +34,6 @@ pip install scikit-transformers
 
 ## Usage
 
-### Most basic usage
-
 For a very basic usage :
 ```python
 import pandas as pd
@@ -53,7 +51,7 @@ logger.fit_transform(df)
 df_transf = logger.transform(df)
 ```
 
-### Using common transformers
+Using common transformers : 
 
 ```python
 import pandas as pd
@@ -71,7 +69,7 @@ df_unique = DropUniqueColumnTransformer().fit_transform(df)
 df_logged = LogTransformer().fit_transform(df)
 ```
 
-### Using a pipeline
+Using a pipeline : 
 
 ```python
 
@@ -95,7 +93,7 @@ df = pd.DataFrame(
 df_transf = pipe.fit_transform(df)
 ```
 
-### Using a pipeline with a scikit-learn model
+Using a pipeline with a scikit-learn model : 
 
 ```python
 import pandas as pd
@@ -127,18 +125,23 @@ y_pred = pipe.predict(X)
 
 ## Documentation
 
-For generic use case, please refer to this [notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/simple_example.ipynb).
+For more specific information, please refer to the notebooks: 
+- [Pipelines notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/Pipelines.ipynb)
+- [BoolColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/BoolColumnTransformer.ipynb)
+- [DropUniqueColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/DropUniqueColumnTransformer.ipynb)
+- [LogColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/LogColumnTransformer.ipynb)
+
 
 <!-- For more specific use case, please refer to this [notebook](docs/detailed_example.ipynb). -->
 
 <!-- For more detailed information, please refer to the [documentation](https://alexandregazagnes.github.io/scikit-transformers/). -->
 
-A complete documentation will be soon available on the  [github page](https://alexandregazagnes.github.io/scikit-transformers/).
+A complete documentation is be available on the  [github page](https://alexandregazagnes.github.io/scikit-transformers/).
 
 
 ## Changelog, Releases and Roadmap
 
-Please refer to the [changelog](https://alexandregazagnes.github.io/scikit-transformers/CHANGELOG/) file for more information.
+Please refer to the [changelog](https://alexandregazagnes.github.io/scikit-transformers/CHANGELOG/) page for more information.
 
 
 ## Contributing
@@ -147,7 +150,7 @@ Pull requests are welcome.
 
 For major changes, please open an issue first to discuss what you would like to change.
 
-For more information, please refer to the [contributing](https://alexandregazagnes.github.io/scikit-transformers/CONTRIBUTING/) file.
+For more information, please refer to the [contributing](https://alexandregazagnes.github.io/scikit-transformers/CONTRIBUTING/) page.
 
 
 ## License

diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md
@@ -5,18 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 
-## -- Not released -- [0.2.1] - 2024-02-08
+## [0.2.1] - 2024-02-09
 
 ### Added
 - Full support for official documentation
 - Add auto deploy documentation with GitHub pages
+- Add notebooks to the documentation
 
 ### Updated
 - Moove assets and utils to docs folder
 - Restructure all package
 - Update documentation to include usage examples
 - Moove Changelog and Contributing to the docs folder
 - Clean code files, remove unused imports, useless comments, and unused variables
+- LogTransformer is now LogColumnTransformer
+- BoolColumnTransformer and DropUniqueColumnTransformer now accept force_df_out attribute
+- Rename modules logger to log
 
 ## [0.2.0] - 2024-02-08
 

diff --git a/docs/docs/api/BoolColumnTransformer.md b/docs/docs/api/BoolColumnTransformer.md
@@ -0,0 +1 @@
+# 1
diff --git a/docs/docs/api/DropUniqueColumnTransformer.md b/docs/docs/api/DropUniqueColumnTransformer.md
@@ -0,0 +1 @@
+# DropUniqueColumnTransformer
diff --git a/docs/docs/api/LogColumnTransformer.md b/docs/docs/api/LogColumnTransformer.md
@@ -0,0 +1 @@
+# LogColumnTransformer
diff --git a/docs/docs/api/Pipelines.md b/docs/docs/api/Pipelines.md
@@ -0,0 +1 @@
+# Pipelines
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -34,8 +34,6 @@ pip install scikit-transformers
 
 ## Usage
 
-### Most basic usage
-
 For a very basic usage :
 ```python
 import pandas as pd
@@ -53,7 +51,7 @@ logger.fit_transform(df)
 df_transf = logger.transform(df)
 ```
 
-### Using common transformers
+Using common transformers : 
 
 ```python
 import pandas as pd
@@ -71,7 +69,7 @@ df_unique = DropUniqueColumnTransformer().fit_transform(df)
 df_logged = LogTransformer().fit_transform(df)
 ```
 
-### Using a pipeline
+Using a pipeline : 
 
 ```python
 
@@ -95,7 +93,7 @@ df = pd.DataFrame(
 df_transf = pipe.fit_transform(df)
 ```
 
-### Using a pipeline with a scikit-learn model
+Using a pipeline with a scikit-learn model : 
 
 ```python
 import pandas as pd
@@ -127,18 +125,23 @@ y_pred = pipe.predict(X)
 
 ## Documentation
 
-For generic use case, please refer to this [notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/simple_example.ipynb).
+For more specific information, please refer to the notebooks: 
+- [Pipelines notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/Pipelines.ipynb)
+- [BoolColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/BoolColumnTransformer.ipynb)
+- [DropUniqueColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/DropUniqueColumnTransformer.ipynb)
+- [LogColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/LogColumnTransformer.ipynb)
+
 
 <!-- For more specific use case, please refer to this [notebook](docs/detailed_example.ipynb). -->
 
 <!-- For more detailed information, please refer to the [documentation](https://alexandregazagnes.github.io/scikit-transformers/). -->
 
-A complete documentation will be soon available on the  [github page](https://alexandregazagnes.github.io/scikit-transformers/).
+A complete documentation is be available on the  [github page](https://alexandregazagnes.github.io/scikit-transformers/).
 
 
 ## Changelog, Releases and Roadmap
 
-Please refer to the [changelog](https://alexandregazagnes.github.io/scikit-transformers/CHANGELOG/) file for more information.
+Please refer to the [changelog](https://alexandregazagnes.github.io/scikit-transformers/CHANGELOG/) page for more information.
 
 
 ## Contributing
@@ -147,7 +150,7 @@ Pull requests are welcome.
 
 For major changes, please open an issue first to discuss what you would like to change.
 
-For more information, please refer to the [contributing](https://alexandregazagnes.github.io/scikit-transformers/CONTRIBUTING/) file.
+For more information, please refer to the [contributing](https://alexandregazagnes.github.io/scikit-transformers/CONTRIBUTING/) page.
 
 
 ## License

diff --git a/docs/docs/usage.md b/docs/docs/usage.md
@@ -97,3 +97,12 @@ pipe.fit(X, y)
 y_pred = pipe.predict(X)
 
 ```
+
+
+## Notebooks
+
+For more specific information, please refer to the notebooks: 
+- [Pipelines notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/Pipelines.ipynb)
+- [BoolColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/BoolColumnTransformer.ipynb)
+- [DropUniqueColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/DropUniqueColumnTransformer.ipynb)
+- [LogColumnTransformer notebook](https://github.com/AlexandreGazagnes/scikit-transformers/blob/main/docs/notebooks/LogColumnTransformer.ipynb)