Spaces:
Sleeping
Sleeping
Luke Stanley
commited on
Commit
•
03b6491
1
Parent(s):
6bfaa63
Add HuggingFace Space demo link
Browse files
README.md
CHANGED
|
@@ -26,12 +26,15 @@ Could Reddit, Twitter, Hacker News, or even YouTube comments be more calm and co
|
|
| 26 |
|
| 27 |
|
| 28 |
|
|
|
|
|
|
|
| 29 |
## Approach ✨
|
| 30 |
|
| 31 |
- **Converts** text to less toxic variations
|
| 32 |
- **Preserves original intent**, focusing on constructive dialogue
|
| 33 |
- **Offline LLM model**: running DIY could save costs, avoid needing to sign up to APIs, and avoid the risk of toxic content causing API access to be revoked. We use llama-cpp-python's server with Mixtral.
|
| 34 |
|
|
|
|
| 35 |
|
| 36 |
## Possible future directions 🌟
|
| 37 |
- **Integration**: offer a Python module and HTTP API, for use from other tools, browser extensions.
|
|
@@ -46,6 +49,13 @@ Could Reddit, Twitter, Hacker News, or even YouTube comments be more calm and co
|
|
| 46 |
|
| 47 |
## Getting Started 🚀
|
| 48 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 49 |
### Installation
|
| 50 |
|
| 51 |
1. Clone the Project Repository:
|
|
@@ -73,9 +83,9 @@ Could Reddit, Twitter, Hacker News, or even YouTube comments be more calm and co
|
|
| 73 |
These config options may need tweaking. Please check out https://llama-cpp-python.readthedocs.io/en/latest/ for more info.
|
| 74 |
|
| 75 |
|
| 76 |
-
### Usage
|
| 77 |
|
| 78 |
-
ChillTranslator
|
| 79 |
```python
|
| 80 |
python3 chill.py
|
| 81 |
```
|
|
@@ -89,7 +99,7 @@ Or chill can be imported as a module, with the improvement_loop function provide
|
|
| 89 |
|
| 90 |
## Contributing 🤝
|
| 91 |
|
| 92 |
-
Contributions are welcome!
|
| 93 |
Especially:
|
| 94 |
- pull requests,
|
| 95 |
- free GPU credits
|
|
|
|
| 26 |
|
| 27 |
|
| 28 |
|
| 29 |
+
You can try out the ChillTranslator directly in your browser through the HuggingFace Space demo at [https://huggingface.co/spaces/lukestanley/ChillTranslator](https://huggingface.co/spaces/lukestanley/ChillTranslator).
|
| 30 |
+
|
| 31 |
## Approach ✨
|
| 32 |
|
| 33 |
- **Converts** text to less toxic variations
|
| 34 |
- **Preserves original intent**, focusing on constructive dialogue
|
| 35 |
- **Offline LLM model**: running DIY could save costs, avoid needing to sign up to APIs, and avoid the risk of toxic content causing API access to be revoked. We use llama-cpp-python's server with Mixtral.
|
| 36 |
|
| 37 |
+
- **HuggingFace Space**: A demo is now available at HuggingFace Spaces, allowing users to try out ChillTranslator without any setup.
|
| 38 |
|
| 39 |
## Possible future directions 🌟
|
| 40 |
- **Integration**: offer a Python module and HTTP API, for use from other tools, browser extensions.
|
|
|
|
| 49 |
|
| 50 |
## Getting Started 🚀
|
| 51 |
|
| 52 |
+
### Try it Online
|
| 53 |
+
|
| 54 |
+
You can try out ChillTranslator without any installation by visiting the HuggingFace Space demo:
|
| 55 |
+
```
|
| 56 |
+
https://huggingface.co/spaces/lukestanley/ChillTranslator
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
### Installation
|
| 60 |
|
| 61 |
1. Clone the Project Repository:
|
|
|
|
| 83 |
These config options may need tweaking. Please check out https://llama-cpp-python.readthedocs.io/en/latest/ for more info.
|
| 84 |
|
| 85 |
|
| 86 |
+
### Local Usage
|
| 87 |
|
| 88 |
+
ChillTranslator can be used locally to improve specific texts. This is how to see it in action:
|
| 89 |
```python
|
| 90 |
python3 chill.py
|
| 91 |
```
|
|
|
|
| 99 |
|
| 100 |
## Contributing 🤝
|
| 101 |
|
| 102 |
+
Contributions are very welcome!
|
| 103 |
Especially:
|
| 104 |
- pull requests,
|
| 105 |
- free GPU credits
|