Merge pull request #17 from rxavier/main

Final touches

Author: r-sosa-gh

README.md

@@ -1,4 +1,4 @@
-# Embedding Encoder
+![](https://raw.githubusercontent.com/cpa-analytics/embedding-encoder/main/logo.png)
 
 ## Overview
 
@@ -110,16 +110,16 @@ Like scikit transformers, Embedding Encoder also has a `inverse_transform` metho
 
 ## Plotting embeddings
 
-The idea behind embeddings is that categories that are conceptually similar should have similar vector representations. For example, "December" and "January" should be close to each other when the target variable is ice cream sales.
+The idea behind embeddings is that categories that are conceptually similar should have similar vector representations. For example, "December" and "January" should be close to each other when the target variable is ice cream sales (here in the Southern Hemisphere at least!).
 
-This can be analyzed with the `plot_embeddings` function.
+This can be analyzed with the `plot_embeddings` function, which depends on Seaborn (`pip install embedding-encoder[sns]` or `pip install embedding-encoder[full]` which includes Tensorflow).
 
 ```python
 from embedding_encoder import EmbeddingEncoder
 
 ee = EmbeddingEncoder(task="classification")
 ee.fit(X=X, y=y)
-ee.plot_embeddings(variable="", model="pca")
+ee.plot_embeddings(variable="...", model="pca")
 ```
 
 ## Advanced usage
@@ -143,4 +143,4 @@ Installing EE without Tensorflow is as easy as removing "[tf]" from the install
 
 ```bash
 pip install embedding-encoder
-```
+```

embedding_encoder/_version.py

@@ -1 +1 @@
-__version__ = "0.0.3"
+__version__ = "0.0.4"

embedding_encoder/core.py

@@ -467,7 +467,7 @@ def get_feature_names(self, input_features=None):
         return self._columns_out
 
     def plot_embeddings(self, variable: str, model: str = "pca"):
-        """Plot embeddings for a variable by passing a fitted EmbeddingEncoder and reducing to 2D.
+        """Create a 2D scatterplot of a variable's embeddings. Each dot represents a category.
 
         Parameters
         ----------