https://github.com/vaultdweller-2287/cyckle-ai
A graphical Phi3 chatbot utility the runs locally on your system!
https://github.com/vaultdweller-2287/cyckle-ai
cython localai phi3-mini python
Last synced: about 1 month ago
JSON representation
A graphical Phi3 chatbot utility the runs locally on your system!
- Host: GitHub
- URL: https://github.com/vaultdweller-2287/cyckle-ai
- Owner: vaultdweller-2287
- License: mit
- Created: 2025-01-16T01:21:07.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-21T20:51:14.000Z (about 2 months ago)
- Last Synced: 2025-04-09T09:15:43.164Z (about 1 month ago)
- Topics: cython, localai, phi3-mini, python
- Language: Cython
- Homepage: https://vaultdweller-2287.github.io/StuffSoft/softpage.html
- Size: 1.46 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cyckle
A graphical GPT4 wrapper built with the gpt4all python library that is locally run and utilizes cython (C-extensions for python).
# Installation
There are 2 methods you can use to install Cyckle.
## Download pre-compiled
This is the easiest way to get Cyckle.
### Step 1: Install prerequisites
From the release notes, download the ```main``` executable and ```dependency-fixer.sh```.
### Step 2: Fix dependencies
We need to run ```dependency-fixer.sh``` in order to fix dependencies. (make sure you are cd'd into the directory where you downloaded the files.)
```
sudo chmod +x install/dependeny-fixer.sh
sudo ./install/dependency-fixer.sh
```
### Step 3: Make the main executable... an *executable*!
Since Linux must know whether or not an executable can actually execute, you must run the following.
```
sudo chmod +x main
```
And to run it
```
./main
```
## Compile it from source
As the title says, this method requires you to compile Cyckle from source. This is pretty easy as it utilizes makefile.
### Step 1: Download prerequisites
The files needed for this are:
- ```makefile``` (found in /install)
- ```wizard.py``` (found in /install)
- ```dependency-fixer.sh``` (found in /install)
- ```main.c```
- ```script.py```
You are going to want to run ```git clone``` to obtain these.
```
git clone https://github.com/vaultdweller-2287/Cyckle-ai
```
Or, you could download the ```bin.tar``` file from the release notes in this github repo.
If you do not have git installed, run the following (depends on your distro, but this is optimized for debian.):
```
sudo apt install git
```
### Step 2: Install dependencies
Before we start, ```cd``` into the folder you cloned the repo in.
```
cd Cyckle-ai
```
You will need to install the required dependencies through ```dependency-fixer```. Here's how to do it:
```
sudo chmod +x install/dependency-fixer.sh
sudo ./install/dependency-fixer.sh
```
The follow dependencies will be installed.
### Step 3: Compile!
In your terminal, run the following:
```
make
```
This will compile ```main.c``` into several binaries necessary for running Cyckle.
### Step 3.1: INCASE OF ERROR!
If you get an error like:
```
make: Nothing to be done for 'all'.
```
You will need to run the following:
```
make clean
```
This will clean the directory and will prepare it for compilation. Once you have ran this, repeat step 3.
### Step 3.2: cleaning
Once everything is done, you may want to tidy up the directory, which can be done like so:
```
sudo chmod +x clean.sh
```
```
sudo ./clean.sh
```
### Step 4: Running
Set the ```main``` exectuable as being able to execute:
```
sudo chmod +x main
```
and then you can run it!
```
./main
```
# Parameters/Commands
The following parameters and commands will display and modify different information.
## Token Modifier
In order to modify the amount of tokens in Cyckle, type ```modtokens``` in the message box. It will pull up a window where you can modify the modtoken parameter. This does not save if you close the program, well at least not yet ;).
## Quit/Exit
Pretty self-explanatory, quits the program. Type ```quit``` or ```exit``` to execute this.
## About
Once again, pretty self-explanatory, shows details about the program. Type ```about``` to execute this.
## Help
Provides a glossary for parameters and commands. type ```help``` to execute this.
# FAQ (Frequently Asked Questions)
These are some questions that are probably never asked but just incase they are, here you go.
## What model does Cyckle use?
Despite using the *GPT*4all library, it actually utilizes ```phi3``` as it's model. We do not plan on adding anymore, though the model itself may change as we aim to have a more lightweight approach to local LLMs.
## Will Cyckle be packaged into my distro's package repos?
We do not plan on native packaging and are currently working on distributing via flatpak.
## What system do I need for Cyckle?
The exact specifications are not known but gpt4all requires any processor with AVX2 (Intel i3 2nd gen). The testing hardware was conducted on an i5-7200u with integrated graphics.
# NOTICE
This software is provided subject to the MIT License and may be republished or distributed only in accordance with the terms of the MIT License.
This software includes third party elements used under an applicable MIT License and this NOTICE represents the required disclosure and notice concerning publication and use of such elements under the applicable MIT License.