Skip to content

Commit

Permalink
Upload module files
Browse files Browse the repository at this point in the history
  • Loading branch information
wassim-khleifi committed Sep 6, 2024
1 parent 12c1665 commit f15f3d3
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,24 @@ Assistant AI is a simple conversational assistant package that uses predefined q
Clone the repository and navigate to your project folder:

```bash
git clone https://github.com/wassim-khleifi/assistantbot.git
cd assistantbot
git clone https://github.com/wassim-khleifi/ai_assistantbot.git
cd ai_assistantbot
```
You can install the package using pip:
```bash
pip install .
```
Or install via pypi:
```bash
pip install assistantbot
pip install ai_assistantbot
```

## Usage:
### Initializing the Assistant:
First, import and initialize the Assistant class with the path to the JSON file that stores the model data:
```py
from assistant import Assistant
import ai_assistantbot
from ai_assistantbot import Assistant

# Initialize the assistant with the model JSON file
assistant = Assistant('path_to_your_model.json')
Expand All @@ -55,8 +56,8 @@ assistant.train_model(new_questions, new_answers)
## Example:
This example is taken from ``examples/example.py``
```py
import assistantbot
from assistantbot.assistant import *
import ai_assistantbot
from ai_assistantbot.assistant import *
# Initialize the assistant with the model JSON file
assistant = Assistant('example.json')
assistant.register() # Register the base model (if not created)
Expand Down
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@
README = (HERE / "README.md").read_text()

setup(
name='assistantbot', # Name of your package
version='0.0.1', # Version of the package
name='ai_assistantbot', # Name of your package
version='0.0.10', # Version of the package
packages=find_packages(), # Automatically find the packages in your project
install_requires=[], # External dependencies (if any)
description='AssistantBot is a python package which provides an question-answering system designed to process large datasets efficiently. By using some AI libraries, it dynamically matches user queries with relevant data, offering accurate responses and easy training process.', # A short description
description='AssistantBot is a python package which provides an question-answering system designed to process large datasets efficiently. It dynamically matches user queries with relevant data, offering accurate responses and easy training process.', # A short description
long_description=README, # Include the README contents
long_description_content_type='text/markdown', # Content type for the description
author='Wassim Khleifi',
author_email='wassimkhleifi@gamil.com',
url='https://github.com/yourusername/my_package', # Optional: link to your repo
url='https://github.com/wassim-khleifi/ai_assistantbot', # Optional: link to your repo
classifiers=[
'Programming Language :: Python :: 3',
'License :: OSI Approved :: MIT License',
Expand Down

0 comments on commit f15f3d3

Please sign in to comment.