Add instructions on how to duplicate/customize the Space

README.md

@@ -20,4 +20,37 @@ Run the following from the terminal:
 ```sh
 poetry install
 poetry run gradio app.py
-```
+```
+
+## Customization
+
+Interested in using Brand Tune for your own brand?
+Begin by duplicating this Hugging Face Space.
+There should be a button with a vertical "..." in the top right.
+If you expand it, there's a "Duplicate this Space" option – click it.
+
+Select the name you want to use.
+The hardware is not important, so pick the cheapest option.
+The actual computation takes place via the OpenAI API,
+so you will need to fill in the `OPENAI_API_KEY` space secret.
+See [here](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key)
+on how to get one.
+
+This will give you a copy of the space that you can edit.
+
+### Brand guidelines
+
+Next, edit `meta_prompt.txt` to describe the style you're looking for.
+
+You can also provide an example input/output pair - like "write an instagram post about X"
+and then an example of what a good answer would look like.
+This can help guide ChatGPT to follow the style you want.
+First, go to `app.py` and set `USE_EXAMPLE = True`.
+Then put the example input into `example_input.txt` and the corresponding output into `example_output.txt`.
+
+### Changing the password
+
+In the chatbot, type "/password [the password you want]".
+This will give you instructions on how to change the password – you'll need to edit `brand_tune/app.py`.
+
+If your Space is public, this will prevent unknown people from using your OpenAI API.

brand_tune/app.py

@@ -8,8 +8,12 @@ import hashlib
 SALT = "this is some random text 4e881d478cbeb1f6e5cb416770"
 CORRECT_HASH = "222632858bf11308f0a7d41cb9fc061a51a47c98da85699706cc663b24aed55e"
 
+# Use the example input and output from example_input.txt and example_output.txt?
+# This can help in specifying the style you'd like to use.
+USE_EXAMPLE = True
 
-def hash(password: str):
+
+def hash_password(password: str):
     return hashlib.sha256((password + SALT).encode()).hexdigest()
 
 
@@ -20,7 +24,7 @@ def gradio_history_to_openai_history(gradio_history: list[list[str]]):
             "content": prompting.PROMPT_TEMPLATE,
         },
     ]
-    if prompting.USE_EXAMPLE:
+    if USE_EXAMPLE:
         openai_history += [
             {"role": "user", "content": prompting.EXAMPLE_INPUT},
             {"role": "assistant", "content": prompting.EXAMPLE_OUTPUT},
@@ -35,18 +39,42 @@ def gradio_history_to_openai_history(gradio_history: list[list[str]]):
 
 
 def bot(history: list[list[str]]):
-    if hash(history[-1][0]) == CORRECT_HASH:
+    last_message = history[-1][0]
+
+    if last_message == "/help":
+        history[-1][1] = (
+            "Welcome to Brand Tune, the tool that helps you keep your brand consistent. "
+            "First, you'll need to enter a password to be able to use the chatbot. "
+            "This is so that unauthorized people don't use the OpenAI API that we "
+            "have to pay for.\n"
+            "For more info, like how to make your own version, "
+            "go to the Files tab and check out README.md."
+        )
+        yield history
+        return
+
+    if last_message.startswith("/password "):
+        password = last_message[len("/password ") :]
+        h = hash_password(password)
+        history[-1][1] = (
+            f'To change the password to "{password}", edit brand_tune/app.py and change '
+            f'the relevant line to:\nCORRECT_HASH = "{h}"'
+        )
+        yield history
+        return
+
+    if hash_password(last_message) == CORRECT_HASH:
         history[-1][1] = "Correct! You can now use the chatbot."
         yield history
         return
     else:
         found = False
         for user_message, bot_message in history:
-            if hash(user_message) == CORRECT_HASH:
+            if hash_password(user_message) == CORRECT_HASH:
                 found = True
                 break
         if not found:
-            history[-1][1] = "Incorrect password. Try again."
+            history[-1][1] = "Incorrect password. Try again. Type /help for help."
             yield history
             return
 

brand_tune/prompting.py

@@ -9,5 +9,3 @@ with (this_dir.parent / "example_input.txt").open() as f:
 
 with (this_dir.parent / "example_output.txt").open() as f:
     EXAMPLE_OUTPUT = f.read()
-
-USE_EXAMPLE = False