wmounger's picture
Update README.md
a7c5934 verified
---
language: en
tags:
- phi
- text-generation
- instruct
pipeline_tag: text-generation
license: mit
inference: true
base_model:
- microsoft/Phi-3-mini-4k-instruct
---
# Phi Shampoo Analyzer WordPress Plugin
A WordPress plugin that analyzes shampoo ingredients using Microsoft's Phi-3.5 models via the Hugging Face Inference API. The plugin evaluates ingredient safety based on user-provided information about allergies and skin types.
## Features
- Analyze shampoo ingredients using Microsoft Phi-3.5-mini-instruct model
- Extract ingredients from images using Microsoft Phi-3.5-vision-instruct model
- Input allergies and skin type for personalized recommendations
- Simple, user-friendly interface
- Test mode for trying the plugin without API calls
## Installation
1. Upload the `phi-shampoo-plugin` folder to your WordPress plugins directory (`/wp-content/plugins/`)
2. Activate the plugin through the 'Plugins' menu in WordPress
3. The plugin will automatically create a "Phi Shampoo Analyzer" page with the analyzer form
## Configuration
1. Go to "Phi Shampoo" in your WordPress admin menu
2. Enter your Hugging Face API token (get one at [huggingface.co/settings/tokens](https://huggingface.co/settings/tokens))
3. Make sure your Hugging Face account has the Inference API enabled
4. Save your settings
> **Important**: Your API token requires at least "Read" access to use the Inference API. Never share your API token publicly.
## Usage
1. Go to the "Phi Shampoo Analyzer" page on your WordPress site
2. Enter shampoo ingredients manually OR upload an image of the ingredient list
3. (Optional) Enter any allergies you have
4. (Optional) Select your skin type
5. Click "Analyze" to get safety recommendations
## Technical Details
- Uses Microsoft Phi-3.5-mini-instruct for text analysis
- Uses Microsoft Phi-3.5-vision-instruct for image processing
- Connects to Hugging Face Inference API
- jQuery for form handling and UI interactions
- Responsive design
## Requirements
- WordPress 5.0 or higher
- PHP 7.2 or higher
- Active internet connection for API calls
- Hugging Face account with Inference API access
## Troubleshooting
If you're experiencing issues with the API connection:
1. Verify your API token is correctly entered in the plugin settings
2. Ensure your Hugging Face account has the Inference API enabled
3. Check that your token has at least "Read" permissions
4. Use the diagnostic tool available in the plugin settings page
## Screenshots
(Screenshots would be added here after plugin implementation)
## License
GPL v2 or later