Skip to content

Commit

Permalink
Add MIT License and improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
Bklieger committed May 20, 2024
1 parent 3a463ed commit c092f44
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Benjamin Klieger

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
# Groqbook: Generate entire books in seconds using Groq and Llama3

![License](https://img.shields.io/badge/license-MIT-green)

Groqbook is a streamlit app that scaffolds the creation of books from a one-line prompt using Llama3 on Groq.


[Demo of Groqbook](https://github.com/Bklieger/groqbook/assets/62450410/3adb11cd-8264-4289-a28a-49dc5b3cf453)
> Demo of Groqbook's fast generation of book content

[Second Part of Demo of Groqbook](https://github.com/Bklieger/groqbook/assets/62450410/5b0147fb-90f3-4584-8572-fa452545d833)
> Demo of Groqbook's ability to download markdown-styled book

Features:
- Scaffolded prompting that strategically switches between Llama3-70b and Llama3-8b to balance speed and quality.

# To use:

### Hosted on Streamlit:


# To run:

To run the streamlit app with your virtual env, run "python3 -m streamlit run main.py"

0 comments on commit c092f44

Please sign in to comment.