🌟 WalkthroughAwanllm

Welcome to WalkthroughAwanllm—the Ruby gem that seamlessly integrates with the AwanLLM API to document your project's development journey. This tool logs activities and generates comprehensive walkthroughs of your project's lifecycle. It lively tracks the git commit history and generates a walkthrough for the same. In order to efficiently use this gem ,install the gem at the beginning of your project development journey itself and make sure to make commits with legible and clear captions.

Credits: All thanks to the creators of the AwanLLM API for providing a free tier.
Contact us at [email protected] or visit awanllm.com.

🚀 Installation

To add this gem to your application, include the following line in your Gemfile:

gem 'walkthrough_awanllm'

Then, run:

$ bundle install

Alternatively, you can install it directly using:

$ gem install walkthrough_awanllm

⚙️ Setup

After installation, configure the gem by running the setup script. This script will prompt you to enter your AwanLLM API key and choose a model name.

$ ruby ./vendor/bundle/ruby/YOUR_VERSION/gems/walkthrough_awanllm-0.2.12/bin/setup_awanllm.rb

👉 Get your API key from AwanLLM.

During setup, you can choose from the following models:

Model Name	Version	Context Limit	SR	PR	Description
Meta-Llama-3-8B-Instruct	3.0	8192	40 t/s	150 t/s	General use, verbose, less refusal
Awanllm-Llama-3-8B-Dolfin	1.0	8192	40 t/s	150 t/s	Exact instruction following, less refusals, no warnings
Awanllm-Llama-3-8B-Cumulus	1.0	8192	40 t/s	150 t/s	Ideal for storywriting or RP, zero refusal, follows characters
Mistral-7B-Instruct	0.3	32768	60 t/s	500 t/s	Fast response, high context limit, function calling

📘 Usage

Generate a Walkthrough

To create a detailed walkthrough of your project's activities, use the following commands in the Rails console:

rails console
> awanllm = WalkthroughAwanllm::AwanLLM.new
> awanllm.generate_walkthrough

If the above doesn't work, you can alternatively run:

$ rails awanllm:generate_walkthrough

This generates a walkthrough.md file in your project's root directory.

You may modify the 'prompt' variable inside ./vendor/bundle/ruby/YOUR_VERSION/gems/walkthrough_awanllm-0.2.12/lib/walkthrough_awanllm.rb to mathc your custom way of creating walkthrough.md file

🛠️ Development

To start developing, check out the repository and run:

$ bin/setup

For an interactive prompt to experiment with the gem:

$ bin/console

To install the gem onto your local machine:

$ bundle exec rake install

To release a new version, update the version number in lib/walkthrough_awanllm/version.rb, and then run:

$ bundle exec rake release

This will create a git tag, push commits and tags, and push the .gem file to RubyGems.org.

🤝 Contributing

We welcome bug reports and pull requests on GitHub. This project fosters a safe and welcoming environment for collaboration. Please read and follow our Code of Conduct.

📜 License

WalkthroughAwanllm is open-source software licensed under the MIT License.

We hope you find WalkthroughAwanllm useful! If you encounter any issues or have suggestions, don't hesitate to reach out. Happy coding! 🚀

mruduljohn / walkthrough_awanllm_gem Goto Github PK