Develop

test.ipynb → .ipynb_checkpoints/test-checkpoint.ipynb

@@ -1,15 +1,22 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Test Jupyter Notebook"
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
     "# import sys\n",
     "# from pathlib import Path\n",
     "# root_dir = Path().resolve().parent  # goes one level up from `test/`\n",
-    "# sys.path.insert(0, str(root_dir))"
+    "# sys.path.insert(0, str(root_dir))\n"
    ]
   },
   {
@@ -303,7 +310,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.7"
+   "version": "3.13.1"
   }
  },
  "nbformat": 4,

Frequently Asked Questions.md

@@ -0,0 +1,123 @@
+## Frequently Asked Questions
+1. Why is my API key not working?
+
+Ensure your API key is correctly set in your environment variables.
+
+Example:
+
+export GROQ_API_KEY="your_api_key_here"
+
+You can also pass it directly in the code using the api_keys parameter.
+
+2. Can I use my own dataset?
+
+Yes. PlotSense works with any pandas DataFrame.
+
+Example:
+
+import pandas as pd
+df = pd.read_csv("your_dataset.csv")
+recommendation = recommender(df)
+
+
+3. Which plots are recommended for categorical variables?
+
+Common plots include:
+
+Bar charts
+
+Boxplots (categorical vs numerical)
+
+PlotSense automatically suggests appropriate plots based on the dataset structure.
+
+4. Do I need a Groq API key to use PlotSense?
+
+Yes. PlotSense uses Groq-hosted LLMs to generate visualization recommendations and explanations.
+
+You can get a free API key at:
+https://console.groq.com/keys
+
+
+5. Can I control which plot gets generated?
+
+Yes. Each recommendation has an index. You can generate a specific plot using that index.
+
+Example:
+
+fig = plotgen(df, 0, recommendation)
+
+6. How do I contribute to PlotSense?
+
+You can contribute by:
+
+Fixing bugs
+
+Adding new plot types
+
+Improving documentation
+
+Suggesting new features
+
+Feel free to open a pull request or issue on GitHub.
+
+7. Why does the plot type sometimes slightly differ from my expectation?
+
+PlotSense uses LLM-based recommendations, which analyze the dataset and propose plots based on statistical relationships and patterns. Results may vary slightly between runs.
+
+8. Can I add my own LLM model?
+
+Currently PlotSense is configured for Groq-hosted models, but the architecture allows adding additional providers by extending the model handlers.
+
+9. What Python version is supported?
+
+PlotSense works best with Python 3.9 or later. Earlier versions may cause dependency issues.
+
+10. What does “ensemble score” mean in the results?
+
+The ensemble score reflects how strongly the models agree on a visualization suggestion.
+Higher scores indicate stronger agreement between models.
+
+11. Can PlotSense generate plots without recommendations?
+
+No. PlotSense requires recommendations first.
+
+12. What happens if the API request fails?
+
+If the API request fails, PlotSense will raise an error such as:
+
+PlotSenseAPIError
+
+PlotSenseDataError
+
+PlotSenseConfigError
+
+Ensure your API key and internet connection are working
+
+13. Does PlotSense modify my original dataset?
+
+No. PlotSense works on a copy of the DataFrame, so the original dataset remains unchanged.
+
+14. Can PlotSense work with time-series data?
+
+Yes. If the dataset contains datetime columns, PlotSense may recommend visualizations such as:
+
+Line plots
+
+Scatter plots
+
+Distribution plots over time.
+
+15. Can I use PlotSense in Jupyter Notebook?
+
+Yes. PlotSense works well inside Jupyter Notebook, Google Colab, and Python scripts.
+
+Example:
+
+recommendation = recommender(df)
+fig = plotgen(df, 0, recommendation)
+
+16. Can PlotSense work offline?
+
+Currently no.
+
+PlotSense requires internet access because it queries LLM models hosted on Groq.

Getting Started.md

@@ -0,0 +1,10 @@
+## Getting Started
+
+1. Install PlotSense
+pip install plotsense
+
+2. Set your GROQ API key
+export GROQ_API_KEY="your_key"
+
+3. Run the example script
+python examples/ test.ipynb

README.md

@@ -278,8 +278,6 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
 
 ### 📅 Roadmap
 
-📖 **[View our detailed Technical Roadmap](https://plotsenseai.gitbook.io/plotsense-technical-roadmap/)**
-
 Upcoming features:
 - More model integrations
 - Automated insight highlighting