comand line interface for Predacons
Project description
Predacons CLI
Welcome to the Predacons CLI! This command-line interface (CLI) allows you to interact with the Predacons library, providing a seamless way to load models, generate responses, and manage configurations directly from your terminal.
Features
- Model Management: Load and manage different types of models including local, Hugging Face safetensor, PyTorch, and GGUF models.
- Interactive Chat: Engage in interactive chat sessions with the loaded model.
- Vector store: Supports vector store allowing user to have conversation with any document or any unstructured data source
- Web Scraper: It can makes google search and answer based on the search results
- Configuration Management: Easily create, update, and clear configuration files.
- Rich Output: Utilize rich text formatting for better readability and user experience.
- Logging: Optionally enable logging for debugging and tracking purposes.
Installation
To install the Predacons CLI, you need to have Python installed on your system. You can install the required dependencies using pip
:
pip install predacons-cli
Usage
Launching the CLI
To start the Predacons CLI, simply run:
predacons
Commands
Once the CLI is launched, you can use the following commands:
clear
: Clear the chat history.exit
: Quit the CLI.clear-config
: Clear the current configuration file.settings
: Show and update settings.version
: Display the current version of the Predacons CLI.help
: Show help information.update
: updates the documents to the vector db
Example Session
$ predacons
Welcome to the Predacons CLI!
No config file found. Creating one now...
Creating a new configuration file...
Please enter the following details to create a new configuration file
...
Welcome to the Predacons CLI! Model: Precacons/Pico-Lamma-3.2-1B-Reasoning-Instruct loaded successfully!
You can start chatting with Predacons now. Type 'clear' to clear history, Type 'exit' to quit, Type 'help' for more options,
User: Hello!
Predacons: Hi there! How can I assist you today?
Configuration
The configuration file is stored at ~/.predacons_cli/predacon_cli_config.json
. You can update the configuration settings by using the settings
command within the CLI.
Configuration Options
model_path
: Path to the model or Hugging Face model name.trust_remote_code
: Boolean to trust remote code.use_fast_generation
: Boolean to enable fast generation.draft_model_name
: Optional draft model name.gguf_file
: Path to the GGUF file.auto_quantize
: Boolean to enable auto quantization.temperature
: Temperature setting for response generation.max_length
: Maximum length for each response.top_k
: Top K value for response generation.top_p
: Top P value for response generation.repetition_penalty
: Repetition penalty value.num_return_sequences
: Number of return sequences.print_as_markdown
: Boolean to print response as markdown.chat_with_data
: enable vector dbvector_db_path
: path to the vector storedocument_path
: path to the directory containing the documentsembedding_model
: embedding model id or pathscrap_web
: enable web scraping
Logging
To enable logging, launch the CLI with the --logs
flag:
python cli.py --logs
License
This project is licensed under the MIT License. See the LICENSE
file for details.
Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
Contact
For any questions or support, please open an issue on the GitHub repository.
Enjoy using the Predacons CLI! 🚀
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file predacons_cli-0.0.101.tar.gz
.
File metadata
- Download URL: predacons_cli-0.0.101.tar.gz
- Upload date:
- Size: 24.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94c33e4fc8aa41e3ae6c4ce33a7d22c2bb9d04213c9ce4ab05fb722dfc135af4 |
|
MD5 | fa5bf40899e6670c751eeb47da2ea1fd |
|
BLAKE2b-256 | c4bd1acb5262927c0376c05539ce1d789bdadffcdfd35e8977ab7fa2223aed3c |
File details
Details for the file predacons_cli-0.0.101-py3-none-any.whl
.
File metadata
- Download URL: predacons_cli-0.0.101-py3-none-any.whl
- Upload date:
- Size: 23.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a4d52eb2196634ec96b1c7e3aa75e2c3e3eb34bd4e87b9c43b4a4c79e255196 |
|
MD5 | e3bc51cbc6ae6317d62263c117775db6 |
|
BLAKE2b-256 | a5655882c91d9f2c4263f7419a909495fb1af55f52710aa8407157505c50d336 |