From 0043bdb4bfb2dabe99fc1c76bdd475cb69a08e16 Mon Sep 17 00:00:00 2001
From: Tom Sawada <103265438+tomohiro-sawada@users.noreply.github.com>
Date: Thu, 12 Oct 2023 02:46:37 -0400
Subject: [PATCH] Update Documentation.tsx
---
src/screens/Documentation/Documentation.tsx | 209 ++++++++++++++------
1 file changed, 153 insertions(+), 56 deletions(-)
diff --git a/src/screens/Documentation/Documentation.tsx b/src/screens/Documentation/Documentation.tsx
index 86854c6..32111af 100644
--- a/src/screens/Documentation/Documentation.tsx
+++ b/src/screens/Documentation/Documentation.tsx
@@ -57,177 +57,275 @@ const Documentation: React.FC = () => {
We provide a simple API to access the Advanced Reasoning Benchmark (ARB). The API currently supports standard HTTP GET requests.
- {/*
+
+ {/*
API Calls
We have three different types of API calls for retrieving problems. See here and select ARB API server as the mock server to see what the outputs look like.
*/}
+
+
+
+
- Get problem by category:
+ Categories without Images.
- You can retrieve all the problems in a particular subject area by the
- following API call. Acceptable values for `category` are `law`,
- `math`, `mcatReading`, etc.
+ For law, problems are retrieved according to the following:
+
+
+
+ import requests
+
+ response =
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/law/")
+
+ data = response.json()
+
+
+
+
+ For math, you can retrieve the problems according to the following template:
- https://advanced-reasoning-benchmark.netlify.app/api/lib/{"{category}"}
+
+ https://advanced-reasoning-benchmark.netlify.app/api/lib/math/{"{answer-type}"}/
+
-
- Math Numerical:
+
+ where acceptable values for `answer-type` are `numerical`, `symbolic`, and `prooflike`.
+
+
+ Numerical
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/math")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/math/numerical")
data = response.json()
-
-
- Math Symbolic:
+
+ Symbolic
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/testSplit/math/symbolic")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/math/symbolic")
data = response.json()
-
-
- Math Proofs:
+
+ Proof-like
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/testSplit/math/proof")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/math/prooflike")
data = response.json()
-
- Physics Numerical:
+
+
+ For MCAT Reading, you can retrieve the problems according to the following template:
+
+
+
+ https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatReading/{"{split}"}
+
+
+
+ where acceptable values for `split` are `val` and `test`.
+
+
+ MCAT Reading Validation Split:
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/physics/val")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatReading/val")
data = response.json()
-
-
- Physics Symbolic:
-
+
+ MCAT Reading Test Split:
+
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/testSplit/physics/val")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatReading/test")
data = response.json()
-
- Law:
+
+
+
+
+
+
+
+ Categories without Images.
+
+
+ For physics and MCAT Science, you can specify whether you want the problems with or without images.
+
+
+
+
+ https://advanced-reasoning-benchmark.netlify.app/api/lib/{"{category}"}/{"{answer-type}"}/{"{modality}"}
+
+
+
+ For physics, acceptable values for `{"{answer-type}"}` are `numerical` and `symbolic`. Acceptable values for `{"{modality}"}` are `img` and `noimg`.
+
+
+ Physics Numerical without Images
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/law")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/physics/numerical/noimg")
data = response.json()
-
-
- MCAT Reading:
+
+ Physics Numerical with Images
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatReading")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/physics/numerical/img")
data = response.json()
-
-
- Get a specific problem by id within category
-
+
+ Physics Symbolic without Images
+
- https://advanced-reasoning-benchmark.netlify.app/api/lib/{"{category}"}/{"{id}"}
+ import requests
+
+ response =
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/physics/symbolic/noimg")
+
+ data = response.json()
+
+ Physics Symbolic with Images
+
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/math/1234")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/physics/symbolic/img")
- problem = response.json()
+ data = response.json()
-
- Get problem by category variation (e.g. img vs val)
-
- For physics and MCAT Science, you can specify whether you want the problems with or without images.
-
+ For MCAT Science, `{"{answer-type}"}` should be filled in with the splits, namely `val` and `test`. Acceptable values for `{"{modality}"}` are `img` and `noimg`. For example, if you want the MCAT Science from the validation split without images, you can use the following template:
+
+
+ MCAT Science Validation Split without Image
- https://advanced-reasoning-benchmark.netlify.app/api/lib/{"{category}"}/{"{variation}"}
+ import requests
+
+ response =
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatScience/val/noimg")
+
+ data = response.json()
-
-
- Physics Numerical w/ Images:
+
+
+ MCAT Science Validation Split with Image
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/physics_numerical/img")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatScience/val/img")
- variation_data = response.json()
+ data = response.json()
-
-
- Physics Symbolic w/ Images:
+
+
+ MCAT Science Test Split without Image
import requests
response =
- requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/testSplit/physics/img")
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatScience/test/noimg")
- variation_data = response.json()
+ data = response.json()
+
+
+
+ MCAT Science Test Split with Image
+
+
+
+ import requests
+
+ response =
+ requests.get("https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatScience/test/img")
+
+ data = response.json()
+
+
+
+
+
+ Get a specific problem by id within category
+
+
+ For any of the above, if you terminate the API call with `/{"id"}`, then you can get a specific problem with that ID.
+
+ Some examples:
+
+
+
+
+ https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatScience/test/noimg/64cdbc1978a46c58407af688
+
+
+
+
+
+
+ https://advanced-reasoning-benchmark.netlify.app/api/lib/math/numerical/64ade9c30b1afac21d212df7
@@ -256,4 +354,3 @@ const Documentation: React.FC = () => {
};
export default Documentation;
-