| Name | freetext-jupyter JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | Freeform text feedback using kordinglab/freetext-server. |
| upload_time | 2023-07-27 15:42:25 |
| maintainer | |
| docs_url | None |
| author | Jordan Matelsky |
| requires_python | >=3.9,<4.0 |
| license | Apache 2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# freetext_jupyter
This is a IPyWidget that interfaces with the Kording Lab `freetext` server. The freetext server is an automatic text feedback system that can be used to provide feedback to students on their written responses to questions.
## Overview
This widget takes the form of a simple text box. The student is presented with the prompt text and a place to answer the question. Upon submitting, the `freetext` server engages a large language model with general knowledge as well as fine-grained knowledge about the question (provided by the instructor) to generate feedback for the student. The feedback is then displayed to the student under the text area, in near-real time, without waiting for a human instructor.
As in all LLM-based tools, caveat emptor: the feedback is not always correct, and it is not always useful. But it is often correct, and it is often useful. The feedback is not meant to replace human instructors, but rather to augment them. The feedback is meant to be used as a starting point to engage meaningful discussion between the students and the instructor.
## Installation
```bash
pip install freetext_jupyter
```
## Usage
```python
from freetext_jupyter import FreetextWidget
FreetextWidget(
# This ID is generated by the instructor by creating a new assignment in
# the freetext server. For more information, see the freetext documentation
# for your community's server.
"07b2c3ef-0f97-46bc-a11e-fc5c06c381c2"
)
```
https://github.com/KordingLab/fretext-jupyter/assets/693511/090a2445-7867-4428-a28a-d5f3a2c96f68
Raw data
{
"_id": null,
"home_page": "",
"name": "freetext-jupyter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Jordan Matelsky",
"author_email": "opensource@matelsky.com",
"download_url": "https://files.pythonhosted.org/packages/9c/31/7f68659cd5f3f4ab4f42accaf13c88bef141cd4b74dcb720d27fe94d0d6e/freetext_jupyter-0.1.0.tar.gz",
"platform": null,
"description": "# freetext_jupyter\n\nThis is a IPyWidget that interfaces with the Kording Lab `freetext` server. The freetext server is an automatic text feedback system that can be used to provide feedback to students on their written responses to questions.\n\n## Overview\n\nThis widget takes the form of a simple text box. The student is presented with the prompt text and a place to answer the question. Upon submitting, the `freetext` server engages a large language model with general knowledge as well as fine-grained knowledge about the question (provided by the instructor) to generate feedback for the student. The feedback is then displayed to the student under the text area, in near-real time, without waiting for a human instructor.\n\nAs in all LLM-based tools, caveat emptor: the feedback is not always correct, and it is not always useful. But it is often correct, and it is often useful. The feedback is not meant to replace human instructors, but rather to augment them. The feedback is meant to be used as a starting point to engage meaningful discussion between the students and the instructor.\n\n## Installation\n\n```bash\npip install freetext_jupyter\n```\n\n## Usage\n\n```python\nfrom freetext_jupyter import FreetextWidget\n\nFreetextWidget(\n # This ID is generated by the instructor by creating a new assignment in\n # the freetext server. For more information, see the freetext documentation\n # for your community's server.\n \"07b2c3ef-0f97-46bc-a11e-fc5c06c381c2\"\n)\n```\n\nhttps://github.com/KordingLab/fretext-jupyter/assets/693511/090a2445-7867-4428-a28a-d5f3a2c96f68\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Freeform text feedback using kordinglab/freetext-server.",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4bc6dcccf1c51bd926eca9695da4d37dc869424b1834cd6f1dfa303db6a75b05",
"md5": "b9009c18367732ccc3ddd5b1dd1265d9",
"sha256": "c70c3dda15773dde92ca48a628a6a9b56af128e258b7a3bc0f621a65e92c0c28"
},
"downloads": -1,
"filename": "freetext_jupyter-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9009c18367732ccc3ddd5b1dd1265d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 3269,
"upload_time": "2023-07-27T15:42:22",
"upload_time_iso_8601": "2023-07-27T15:42:22.942626Z",
"url": "https://files.pythonhosted.org/packages/4b/c6/dcccf1c51bd926eca9695da4d37dc869424b1834cd6f1dfa303db6a75b05/freetext_jupyter-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c317f68659cd5f3f4ab4f42accaf13c88bef141cd4b74dcb720d27fe94d0d6e",
"md5": "1135c0827a7e492935552183ebc752d1",
"sha256": "79af875f3b0118b03a7226850c6e29efd8d8a1a4ae9231cfca4c0b1ae5951723"
},
"downloads": -1,
"filename": "freetext_jupyter-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1135c0827a7e492935552183ebc752d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 2832,
"upload_time": "2023-07-27T15:42:25",
"upload_time_iso_8601": "2023-07-27T15:42:25.987302Z",
"url": "https://files.pythonhosted.org/packages/9c/31/7f68659cd5f3f4ab4f42accaf13c88bef141cd4b74dcb720d27fe94d0d6e/freetext_jupyter-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-27 15:42:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "freetext-jupyter"
}
