You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs(readme): add Playground link, try-evaluators section, copy edits
- Link to Evaluators Playground in header and new section
- Normalize heading capitalization; tighten quick start wording
- Replace partner CTA with Stay up to date / Learning Commons account
- Fix playground sentence link markup
Evaluators and the supporting datasets are built in collaboration with leading literacy experts from Student Achievement Partners and the Achievement Network.
24
26
25
-
## **Repository Contents**
27
+
## **Repository contents**
26
28
27
29
| Path | Description |
28
30
| :---- | :---- |
@@ -32,10 +34,13 @@ Evaluators and the supporting datasets are built in collaboration with leading l
32
34
33
35
Check out the [full docs](https://docs.learningcommons.org/evaluators) for complete setup instructions and usage examples.
34
36
37
+
## **Try the evaluators**
35
38
36
-
## **Quick Start**
39
+
You can test the evaluators with your own text in the [Evaluators Playground](https://platform.learningcommons.org/apps/evaluators/playground) on the Learning Commons Platform.
37
40
38
-
To try or use the evaluators, clone the repository and follow the instructions below.
41
+
## **Quickstart**
42
+
43
+
To use the evaluators, clone the repository and follow the instructions below.
39
44
40
45
If you’d like to download or access our evaluators and datasets directly, follow the links below.
41
46
@@ -47,15 +52,15 @@ If you’d like to download or access our evaluators and datasets directly, foll
47
52
48
53
## **Requirements**
49
54
50
-
We rely on the python interpreter to power the evaluators. All examples and tutorials are provided as python code snippets.
55
+
We rely on the Python interpreter to power the evaluators. All examples and tutorials are provided as Python code snippets.
51
56
52
57
---
53
58
<detailsopen>
54
59
<summary>Setup on Mac/Linux</summary>
55
60
56
61
## **Setup on Mac/Linux**
57
62
58
-
You’ll need Python 3.10 or newer. To verify your version of python, run the following code in the terminal:
63
+
You’ll need Python 3.10 or newer. To verify your version of Python, run the following code in the terminal:
59
64
60
65
```shell
61
66
python3 --version
@@ -74,7 +79,7 @@ Remember to activate the virtual environment for each new shell session when wor
74
79
75
80
### 2. Install dependencies
76
81
77
-
The list of required packages is provided in the `requirements.txt` file.
82
+
The required packages are listed in the `requirements.txt` file.
You are now ready to run the evaluator examples. We recommend using a Jupyter Notebook for interactive exploration.
160
165
@@ -171,21 +176,14 @@ Jupyter will open in your web browser (usually at `http://localhost:8888`).
171
176
172
177
If you prefer using an IDE with Python and Jupyter notebook support, such as VSCode with Microsoft's Python and Jupyter extensions, please refer to Microsoft's instructions for their installation and configuration.)
173
178
174
-
## **Support & Feedback**
179
+
## **Support & feedback**
175
180
176
181
We want to hear from you. For questions or feedback, please [open an issue](https://github.com/learning-commons-org/evaluators/issues) or reach out to us at [support@learningcommons.org](mailto:support@learningcommons.org)
177
182
178
-
## **Partner with us**
179
-
180
-
**Learn more about our Evaluators or join** our private beta to access:
181
-
182
-
* Full set of Evaluators focused on Literacy and Student Feedback
183
-
* Early access to new features, including our API and dashboards
184
-
* Personalized support from the Evaluators team
185
-
186
-
Contact us [here](https://learningcommons.org/contact/?utm_source=github&utm_medium=evals&utm_campaign=privatebeta).
183
+
## **Stay up to date**
184
+
Sign up for a <ahref="https://platform.learningcommons.org"target="_blank">Learning Commons account</a> to receive news about the latest Evaluators updates, and releases.
187
185
188
-
## **Reporting Security Issues**
186
+
## **Reporting security issues**
189
187
190
188
If you believe you have found a security issue, please responsibly disclose by contacting us at [security@learningcommons.org](mailto:security@learningcommons.org).
0 commit comments