sherrybabe1978 commited on
Commit
c12e3e9
·
verified ·
1 Parent(s): d872907

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -27
README.md CHANGED
@@ -1,58 +1,62 @@
1
  ---
2
- title: GPTo1
3
  emoji: 🌍
4
  colorFrom: red
5
  colorTo: yellow
6
  sdk: streamlit
7
- sdk_version: 1.39.0
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
  # GPTo1: Llama-3.1 70b on Groq for o1-like Reasoning Chains
13
 
14
- This Hugging Face Space demonstrates the use of Llama-3.1 70b on Groq to create o1-like reasoning chains, improving output accuracy in AI-generated responses.
15
 
16
- ## Important Note
17
 
18
- This Hugging Face Space is a collaborative project worked on with Alisher (https://github.com/afarhadi99), based on the g1 project created by bklieger-groq. The original GitHub repository can be found at https://github.com/bklieger-groq/g1. We have adapted it for use as a Hugging Face Space and potentially added some additional features.
19
 
20
  ## How to Use This Space
21
 
22
- 1. Duplicate this space:
23
  - Click on the "Duplicate this Space" button at the top right of the page.
24
- - Choose a name for your duplicated space and click "Duplicate Space".
 
 
 
 
 
 
25
 
26
  2. Set up your Groq API key:
27
- - In your duplicated space, go to the "Settings" tab.
28
- - Scroll down to the "Repository secrets" section.
29
- - Click on "New secret".
30
- - Set the secret name as `GROQ_API_KEY`.
31
- - Paste your Groq API key as the value.
32
- - Click "Add secret".
33
 
34
- 3. Rebuild the space:
35
- - After adding the API key, go to the "Factory" tab.
36
- - Click on "Rebuild Space".
37
 
38
- 4. Use the app:
39
- - Once the rebuild is complete, go to the "App" tab.
40
- - You should now see the interface where you can enter queries and get responses.
41
 
42
- ## Note
 
 
43
 
44
- Make sure to keep your API key confidential and do not share it with others. Each person should use their own Groq API key when duplicating this space.
45
 
46
- ## Original Project
47
 
48
- This Hugging Face Space is based on the g1 project. For more information, updates, or to contribute to the original project, please visit the GitHub repository:
49
 
50
- https://github.com/bklieger-groq/g1
 
 
51
 
52
- ## Acknowledgments
53
 
54
- - Special thanks to bklieger-groq for creating the original g1 project that serves as the foundation for this Hugging Face Space.
55
- - This Hugging Face adaptation is a collaborative effort with Alisher Farhadi (https://github.com/afarhadi99).
56
 
57
  ## Contributing
58
 
@@ -62,6 +66,12 @@ If you'd like to contribute to this project, please consider contributing to the
62
 
63
  This project is open source and available under the license specified in the original GitHub repository. Please refer to the repository for the most up-to-date license information.
64
 
 
 
 
 
 
 
65
  ## Configuration Reference
66
 
67
  For more information about the Hugging Face Spaces configuration, please refer to:
 
1
  ---
2
+ title: llamalogic
3
  emoji: 🌍
4
  colorFrom: red
5
  colorTo: yellow
6
  sdk: streamlit
7
+ sdk_version: 1.38.0
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
  # GPTo1: Llama-3.1 70b on Groq for o1-like Reasoning Chains
13
 
14
+ This Hugging Face Space demonstrates the use of Llama-3.1 70b on Groq to create o1-like reasoning chains, aiming to improve output accuracy in AI-generated responses.
15
 
16
+ ## Important: Private Use Required
17
 
18
+ For security reasons, it is required to use this space privately. This ensures that your Groq API key remains secure when entered in the interface.
19
 
20
  ## How to Use This Space
21
 
22
+ 1. Duplicate this space as a private space:
23
  - Click on the "Duplicate this Space" button at the top right of the page.
24
+ - Choose a name for your duplicated space.
25
+ - Important: Set the visibility to "Private" to ensure the security of your API key.
26
+ This is crucial because you'll be entering your API key in the interface.
27
+ - Click "Duplicate Space".
28
+
29
+ Note: Setting the space to private is essential for protecting your Groq API key.
30
+ In a public space, there's a risk of exposing your API key to others.
31
 
32
  2. Set up your Groq API key:
33
+ - Once you've duplicated the space, go to the "App" tab.
34
+ - You'll see a text input field where you can enter your Groq API key.
35
+ - Enter your API key and click the "Submit API Key" button.
 
 
 
36
 
37
+ 3. Use the app:
38
+ - After submitting your API key, you should see the interface where you can enter queries and get responses.
 
39
 
40
+ ## Note on API Key Security
 
 
41
 
42
+ - Never share your Groq API key or make it public.
43
+ - If you accidentally expose your API key, regenerate a new one immediately from your Groq account.
44
+ - Make sure to keep your API key confidential. Each person should use their own Groq API key when using this space.
45
 
46
+ ## About This Project
47
 
48
+ This Hugging Face Space is a collaborative project worked on with Alisher Farhadi (https://github.com/afarhadi99), based on the g1 project created by bklieger-groq. The original GitHub repository can be found at https://github.com/bklieger-groq/g1. We have adapted it for use as a Hugging Face Space and potentially added some additional features.
49
 
50
+ ## Features
51
 
52
+ - Uses Llama-3.1 70b model via Groq API
53
+ - Implements o1-like reasoning chains for improved accuracy
54
+ - Provides step-by-step explanations of the reasoning process
55
 
56
+ ## Limitations
57
 
58
+ - This is an early prototype and accuracy has not been formally evaluated.
59
+ - Performance may vary depending on the complexity of the query.
60
 
61
  ## Contributing
62
 
 
66
 
67
  This project is open source and available under the license specified in the original GitHub repository. Please refer to the repository for the most up-to-date license information.
68
 
69
+ ## Acknowledgments
70
+
71
+ - Special thanks to bklieger-groq for creating the original g1 project that serves as the foundation for this Hugging Face Space.
72
+ - This Hugging Face adaptation is a collaborative effort with Alisher Farhadi (https://github.com/afarhadi99).
73
+ - Powered by Groq for fast reasoning steps.
74
+
75
  ## Configuration Reference
76
 
77
  For more information about the Hugging Face Spaces configuration, please refer to: