Skip to content

Commit 359471f

Browse files
authored
docs(readme): Playground link, try-evaluators section, copy edits (#30)
* 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
1 parent 31a2265 commit 359471f

1 file changed

Lines changed: 17 additions & 19 deletions

File tree

README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
<img style="width:100%" alt="evaluator_banner" src="https://raw.githubusercontent.com/learning-commons-org/.github/refs/heads/main/assets/evals_hero.png" />
22

33
<p align="center">
4+
<a href="https://platform.learningcommons.org/apps/evaluators/playground" target="_blank">Try it in the Playground </a>
5+
46
<a href="https://docs.learningcommons.org/evaluators/quick-start/getting-set-up" target="_blank">Getting set up</a>
57
68
<a href="https://docs.learningcommons.org/evaluators/using-evaluators/tutorial-evaluating-grade-level-appropriateness" target="_blank">Tutorials</a>
79
8-
<a href="https://docs.learningcommons.org/evaluators/quick-start/core-concepts" target="_blank">Core Concepts</a>
10+
<a href="https://docs.learningcommons.org/evaluators/quick-start/core-concepts" target="_blank">Core concepts</a>
911
</p>
1012

1113
## **Evaluators**
@@ -22,7 +24,7 @@ Use cases include:
2224

2325
Evaluators and the supporting datasets are built in collaboration with leading literacy experts from Student Achievement Partners and the Achievement Network.
2426

25-
## **Repository Contents**
27+
## **Repository contents**
2628

2729
| Path | Description |
2830
| :---- | :---- |
@@ -32,10 +34,13 @@ Evaluators and the supporting datasets are built in collaboration with leading l
3234

3335
Check out the [full docs](https://docs.learningcommons.org/evaluators) for complete setup instructions and usage examples.
3436

37+
## **Try the evaluators**
3538

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.
3740

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.
3944

4045
If you’d like to download or access our evaluators and datasets directly, follow the links below.
4146

@@ -47,15 +52,15 @@ If you’d like to download or access our evaluators and datasets directly, foll
4752

4853
## **Requirements**
4954

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.
5156

5257
---
5358
<details open>
5459
<summary>Setup on Mac/Linux</summary>
5560

5661
## **Setup on Mac/Linux**
5762

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:
5964

6065
```shell
6166
python3 --version
@@ -74,7 +79,7 @@ Remember to activate the virtual environment for each new shell session when wor
7479

7580
### 2. Install dependencies
7681

77-
The list of required packages is provided in the `requirements.txt` file.
82+
The required packages are listed in the `requirements.txt` file.
7883

7984
```shell
8085
pip install -r evals/requirements.txt
@@ -154,7 +159,7 @@ $env:GOOGLE_API_KEY="your-key-here"
154159
```
155160
</details>
156161

157-
## Run the Evaluator Code
162+
## Run the Evaluators' code
158163

159164
You are now ready to run the evaluator examples. We recommend using a Jupyter Notebook for interactive exploration.
160165

@@ -171,21 +176,14 @@ Jupyter will open in your web browser (usually at `http://localhost:8888`).
171176

172177
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.)
173178

174-
## **Support & Feedback**
179+
## **Support & feedback**
175180

176181
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)
177182

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 <a href="https://platform.learningcommons.org" target="_blank">Learning Commons account</a> to receive news about the latest Evaluators updates, and releases.
187185

188-
## **Reporting Security Issues**
186+
## **Reporting security issues**
189187

190188
If you believe you have found a security issue, please responsibly disclose by contacting us at [security@learningcommons.org](mailto:security@learningcommons.org).
191189

0 commit comments

Comments
 (0)