chore: Update documentation and remove unused files

README.md

@@ -55,6 +55,9 @@ Then:
 
 This will setup the necessary environment variables and download the necessary data.
 
+> [!TIP]
+> Having trouble installing? Or don't want to install redis for now? We are working on a public redis server for you to use. Stay tuned!
+
 OpenAI key is required to run the code. Please set the environment variable `OPENAI_API_KEY` to your key. The recommend way is to add the key to the conda environment:
 ```bash
 conda env config vars set OPENAI_API_KEY=your_key

docs/pages/_meta.json

@@ -10,49 +10,14 @@
     },
     "concepts": {
         "title": "Concepts",
-        "type": "menu",
-        "items": {
-            "agents": {
-                "title": "Agents",
-                "href": "/agents"
-            },
-            "environments": {
-                "title": "Environments",
-                "href": "/environments"
-            },
-            "hyperparameters": {
-                "title": "Hyperparameters",
-                "href": "/hyperparameters"
-            },
-            "scripts": {
-                "title": "Scripts",
-                "href": "/scripts"
-            },
-            "benchmark": {
-                "title": "Benchmark",
-                "href": "/benchmark"
-            },
-            "xml": {
-                "title": "XML Formatter",
-                "href": "/xml"
-
-            }
-        }
+        "type": "page"
     },
     "examples": {
         "title": "Examples",
-        "type": "menu",
-        "items": {
-            "examples": {
-                "title": "Examples",
-                "href": "/examples"
-            }
-        }
+        "type": "page"
     },
-    "getting-started": {
-        "title": "Getting Started",
-        "type": "menu",
-        "items": {
-        }
+    "contribution": {
+        "title": "Contribution",
+        "type": "page"
     }
 }

docs/pages/examples/experiment.md

@@ -18,3 +18,10 @@ To run a large batch of environments, you can change the `ENV_IDS` parameter in
 After running experiments, you can go to the `examples/redis_stats.ipynb` notebook to check the existing episodes (Episode Log section), as well as calculate the performance.
 
 For the original Sotopia simulation in our paper's experiments, you can find how to get them in the [Q&A](/docs/troubleshooting.md) section in the `./docs` folder.
+
+# Hyperparameters that are used in the simulation
+
+## Tags
+
+- `TAG`: The tag of the simulation. This tag is used to identify the simulation in the database.
+- `TAG_TO_CHECK_EXISTING_EPISODES`: Scripts like `examples/experiment_eval.py` checks if there are existing episodes with the same tag in the database. If there are, the simulation **will not** be run. This is to avoid running the same simulation twice. If you want to run the simulation again, you can change the tag or set `TAG_TO_CHECK_EXISTING_EPISODES` to `None`.

docs/pages/troubleshooting.md → docs/pages/examples/troubleshooting.md

@@ -33,13 +33,13 @@ Redis saves snapshots of the database every few minutes. You can find them in th
 When utilizing the database in python code (as introduced in [here](https://github.com/sotopia-lab/sotopia/blob/main/notebooks/redis_stats.ipynb)), make sure you use in the command line:
 
 ```sh
-export REDIS_OM_URL="redis://:QzmCUD3C3RdsR@localhost:6379"
+export REDIS_OM_URL="<your_redis_url>"
 ```
 
 If you plan to add environmental variables in the python code like this:
 
 ```sh
-os.environ['REDIS_OM_URL'] = "redis://:QzmCUD3C3RdsR@localhost:6379"
+os.environ['REDIS_OM_URL'] = "<your_redis_url>"
 ```
 
 We need to make sure this line of code is put before `import redis` to make sure that you will not face additional authorization error.