Skip to content

Commit 92b2422

Browse files
committed
Switched all RA docs to just link to the evaluation function docs
1 parent b00869f commit 92b2422

File tree

10 files changed

+20
-58
lines changed

10 files changed

+20
-58
lines changed

docs/teacher/reference/response_area_components/Boolean.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,4 @@ This response area allows students to select True or False.
44

55
## Evaluation Function Options
66

7-
### `isExactEqual`
8-
9-
Checks if the answer is exactly equal to the response. In this case if the response is True or False.
10-
The `type` should be set to `bool`, to ensure boolean comparison.
7+
### [isExactEqual](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/isExactEqual/)

docs/teacher/reference/response_area_components/Code.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,7 @@ This response area allows students to write code for a specified programming lan
44

55
## Evaluation Function Options
66

7-
### `chatGPT (experimental)`
7+
### [chatGPT (experimental)](https://github.com/lambda-feedback/chatGPT/blob/main/app/docs/user.md)
88

9-
Passes the student's response and a teacher written prompt to GPT for evaluation.
109

11-
12-
### `compareContsructs (experimental)`
13-
Python Only. Compares console output to a teacher's provided answer and comparing the structure of the teacher's solution to the student provided responses.
14-
Student functions can also be ran against a set of teacher provided unit tests, if these fails, feedback can be generated by GPT if enabled.
15-
It also provides feedback on syntax and style.
10+
### [`compareContsructs (experimental)`](https://github.com/lambda-feedback/compareConstructs/blob/main/docs/user.md)

docs/teacher/reference/response_area_components/Essay.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,4 @@ Similar to [!Text](Text.md), allows student's to enter any text input, whether t
77
As text supports any input, so most evaluation functions can be used.
88
However, there are some text specific evaluation functions, such as shortTextAnswer and chatGPT.
99

10-
### `chatGPT (experimental)`
11-
12-
Passes the student's response and a teacher written prompt to GPT for evaluation.
10+
### [chatGPT (experimental)](https://github.com/lambda-feedback/chatGPT/blob/main/app/docs/user.md)

docs/teacher/reference/response_area_components/Expression.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,12 @@ This response area is very similar to [Text](Text.md), differing in that it can
44

55
## Evaluation Function Options
66

7-
### `isSimilar`
7+
### [isSimilar](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/isSimilar/)
88

9-
Calculates the difference between the teacher answer (ans) and the student response (res); compares this to an allowable difference comprising an absolute tolerance (atol) and a relative tolerance (rtol).
9+
### [symbolicEqual](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/symbolicEqual/)
1010

11-
### `symbolicEqual`
11+
### [compareExpressions](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/compareExpressions/)
1212

13-
Compares two symbolic expressions for mathematical equivalence, using SymPy. See [SymPy](https://www.sympy.org/en/index.html.md-button) for further information.
14-
15-
## compareExpressions
16-
**Input Symbols**
17-
18-
This is a powerful feature for defining a dictionary of accepted symbols. For each symbol, you define:
19-
20-
* **Symbol:** The LaTeX-rendered symbol (e.g., `$f(x)$`).
21-
* **Code:** The machine-readable variable name (e.g., `fx`). This is what your students will type and what the evaluation function sees.
22-
* **Alternatives:** A list of other codes you want to accept for the same symbol (e.g., `f_x`, `f(x)`, `f`). This allows you to anticipate different ways students might type the same thing.
23-
* **Visibility:** A `TRUE`/`FALSE` toggle. If "Display input symbols" is enabled in the Input tab, this setting determines whether a specific symbol is shown to the student. This allows you to show students common symbols while still accepting less common or alternative ones in the background.
24-
25-
![example](screenshots/input_symbols.png)
26-
![example](screenshots/input_symbols_preview.png)
27-
28-
Tolerances can also be added. These will apply to the numerical parts of the answer (e.g. the $10$ in $10x$).
29-
30-
This is done using the `atol` and `rtol` fields under the Evaluation Function Parameters section.
3113

3214
## Component Parameters
3315

docs/teacher/reference/response_area_components/Matrix.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,9 @@ Matrix response area. Will populate the component with a grid of text input fiel
44

55
## Evaluation Function Options
66

7-
### ArrayEqual
8-
Evaluation function checks if the supplied response and answer arrays are within the optionally supplied tolerances. This is based on the [numpy.allclose](https://numpy.org/doc/stable/reference/generated/numpy.allclose.html) function. Numpy is a dependancy for this function, but it means that arrays of any shape (regular) can be compared efficiently.
9-
10-
11-
### ArraySymbolicEqual
12-
Very similar to the SymbolicEqual grading function, but grading any list of expressions instead. This algorithm can take any level of nesting for "response" and "answer" fields, as grading is done recursively (as long as both shapes are identical). Symbolic grading is done using the SymPy library. See [SymPy](https://www.sympy.org/en/index.html.md-button) for further information.
7+
### [ArrayEqual](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/arrayEqual/)
138

9+
### [ArraySymbolicEqual](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/arraySymbolicEqual/)
1410

1511
## Component Parameters
1612
### `rows and cols` (required)

docs/teacher/reference/response_area_components/MultipleChoice.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ General multiple choice response area. Features multiple options for single answ
44

55
## Evaluation Function Options
66

7-
### ArrayEqual
8-
Evaluation function checks if the supplied response and answer arrays are within the optionally supplied tolerances. This is based on the [numpy.allclose](https://numpy.org/doc/stable/reference/generated/numpy.allclose.html) function. Numpy is a dependancy for this function, but it means that arrays of any shape (regular) can be compared efficiently.
7+
### [ArrayEqual](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/arrayEqual/)
98

109
## Parameters
1110
### `options` (required)

docs/teacher/reference/response_area_components/Number.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ Very similar to the [Text](Text.md) response area, except the user response is p
44

55
## Evaluation Function Options
66

7-
### `isSimilar`
8-
Calculates the difference between the teacher answer (ans) and the student response (res); compares this to an allowable difference comprising an absolute tolerance (atol) and a relative tolerance (rtol).
7+
### [isSimilar](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/isSimilar/)
98

10-
### `isExactEqual`
11-
A strict comparison in Python using '=='. This function is a basic utility but often not the function you really want to use because it is quite brittle.
9+
### [isExactEqual](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/isExactEqual/)
1210

1311
## Setting The Answer
1412

docs/teacher/reference/response_area_components/NumericUnits.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Provides two input fields with `Number` and `Units` placeholder texts. This area
44

55
**Note:** this area will display how the user's response was interpred using the `interp_string` field provided in the feedback object returned by that function (if it exists).
66

7+
## Evaluation Function Options
8+
9+
### [compareExpressions](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/compareExpressions/)
10+
711
## Component Parameters
812
### `pre_response_text` & `post_response_text` (optional)
913
Text block to be displayed to the left and right of the input field respectively. Markdown and LaTeX are allowed following the usual syntax.

docs/teacher/reference/response_area_components/Table.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@ Table response area. Will populate the component with a grid of text input field
55

66
## Evaluation Function Options
77

8-
### ArrayEqual
9-
Evaluation function checks if the supplied response and answer arrays are within the optionally supplied tolerances. This is based on the [numpy.allclose](https://numpy.org/doc/stable/reference/generated/numpy.allclose.html) function. Numpy is a dependancy for this function, but it means that arrays of any shape (regular) can be compared efficiently.
10-
11-
12-
### ArraySymbolicEqual
13-
Very similar to the SymbolicEqual grading function, but grading any list of expressions instead. This algorithm can take any level of nesting for "response" and "answer" fields, as grading is done recursively (as long as both shapes are identical). Symbolic grading is done using the SymPy library. See [SymPy](https://www.sympy.org/en/index.html.md-button) for further information.
8+
### [ArrayEqual](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/arrayEqual/)
149

10+
### [ArraySymbolicEqual](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/arraySymbolicEqual/)
1511

1612
## Component Parameters
1713

docs/teacher/reference/response_area_components/Text.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ Allows student's to enter any text input, whether that be prose, math, code or a
77
As text supports any input, any evaluation function can be used.
88
However, there are some text specific evaluation functions, such as shortTextAnswer and chatGPT.
99

10-
### `chatGPT (experimental)`
10+
### [chatGPT (experimental)](https://github.com/lambda-feedback/chatGPT/blob/main/app/docs/user.md)
1111

12-
Passes the student's response and a teacher written prompt to GPT for evaluation.
13-
14-
### `shortTextAnswer (experimental)`
15-
Uses natural language processing techniques to calculate the similarity between a student's response and a teacher's answer, using semantic similarity.
12+
###[ shortTextAnswer (experimental)](https://github.com/lambda-feedback/shortTextAnswer/blob/main/app/docs/user.md)

0 commit comments

Comments
 (0)