# GroTE: Groningen Translation Environment 🐮
## Accessing the GroTE demo
An online GroTE demo is available at [https://grote-app.hf.space](https://grote-app.hf.space). The demo will log events to the private repository [grote/grote-logs](https://huggingface.co/datasets/grote/grote-logs).
## Running GroTE locally
1. Install requirements: `pip install -r requirements.txt`.
2. Make sure you have a local `npm` installation available to run the front-end.
3. Run `grote` in your command line to start the server.
4. Visit http://127.0.0.1:7860 to access the demo. By default, logs are written to the local `logs` directory, which is synchronized with the repository [grote/grote-logs](https://huggingface.co/datasets/grote/grote-logs).
## TODOs for before the QE4PE study
- [x] Add a JS check to prevent users from accidentally closing the tab while editing.
- [x] Remove trailing spaces in parsed texts.
- [x] Make Ctrl+C on source sentences a customizable option (default: allowed).
- [x] Minimize HF bar by default with `header: mini` in README.
## TODOs for after QE4PE study
- [ ] Separate rendering logic for loading/editing tabs (see [ICLR 2024 Papers interface](https://huggingface.co/spaces/ICLR2024/update-ICLR2024-papers/blob/main/app.py) for an example)
- [ ] Enable restoring the previous state of edited sentences if matching filename and user are found in the logs in the past 24 hours (modal to enable starting from scratch).
- [ ] Possibly rethink logging format to reduce redundancy and improve readability.
- [ ] Add optional tab to visualize the editing process (e.g., Highlighted diffs between original and edited sentences, replay of editing process by looping `.then` with `time.sleep`, download scoped logs for single text).
- [ ] Change saving logic to use [BackgroundScheduler](https://www.gradio.app/guides/running-background-tasks)
- [ ] Change transition from editing to loading to preserve login code and possibly allow the pre-loading of several files for editing (would require custom `FileExplorer` to mark done documents).
- [ ] Write tutorial on how to
Raw data
{
"_id": null,
"home_page": "https://github.com/gsarti/grote",
"name": "grote",
"maintainer": "Gabriele Sarti",
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": "gabriele.sarti996@gmail.com",
"keywords": "translation environment, gradio",
"author": "Gabriele Sarti",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ca/95/bcb40bbe2813ce6a59a08294e4e81744daa2d9411713cd789eacd8678a10/grote-0.1.10.tar.gz",
"platform": null,
"description": "# GroTE: Groningen Translation Environment \ud83d\udc2e\n\n## Accessing the GroTE demo\n\nAn online GroTE demo is available at [https://grote-app.hf.space](https://grote-app.hf.space). The demo will log events to the private repository [grote/grote-logs](https://huggingface.co/datasets/grote/grote-logs).\n\n## Running GroTE locally\n\n1. Install requirements: `pip install -r requirements.txt`.\n2. Make sure you have a local `npm` installation available to run the front-end.\n3. Run `grote` in your command line to start the server.\n4. Visit http://127.0.0.1:7860 to access the demo. By default, logs are written to the local `logs` directory, which is synchronized with the repository [grote/grote-logs](https://huggingface.co/datasets/grote/grote-logs).\n\n## TODOs for before the QE4PE study\n\n- [x] Add a JS check to prevent users from accidentally closing the tab while editing.\n- [x] Remove trailing spaces in parsed texts.\n- [x] Make Ctrl+C on source sentences a customizable option (default: allowed).\n- [x] Minimize HF bar by default with `header: mini` in README.\n\n## TODOs for after QE4PE study\n\n- [ ] Separate rendering logic for loading/editing tabs (see [ICLR 2024 Papers interface](https://huggingface.co/spaces/ICLR2024/update-ICLR2024-papers/blob/main/app.py) for an example)\n- [ ] Enable restoring the previous state of edited sentences if matching filename and user are found in the logs in the past 24 hours (modal to enable starting from scratch).\n- [ ] Possibly rethink logging format to reduce redundancy and improve readability.\n- [ ] Add optional tab to visualize the editing process (e.g., Highlighted diffs between original and edited sentences, replay of editing process by looping `.then` with `time.sleep`, download scoped logs for single text).\n- [ ] Change saving logic to use [BackgroundScheduler](https://www.gradio.app/guides/running-background-tasks)\n- [ ] Change transition from editing to loading to preserve login code and possibly allow the pre-loading of several files for editing (would require custom `FileExplorer` to mark done documents).\n- [ ] Write tutorial on how to \n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Groningen Translation Environment",
"version": "0.1.10",
"project_urls": {
"Homepage": "https://github.com/gsarti/grote",
"Repository": "https://github.com/gsarti/grote"
},
"split_keywords": [
"translation environment",
" gradio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ed7850f54c925215fbca7db501c94805539702238e56522e0d4111b8f2a5ab7",
"md5": "afa6763e3b4d92e7a37464e73f35933e",
"sha256": "c943f954125e40595494a5ae953fdfee8678f849782078bf25eea6c8314edee1"
},
"downloads": -1,
"filename": "grote-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afa6763e3b4d92e7a37464e73f35933e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 22074,
"upload_time": "2024-05-16T14:48:00",
"upload_time_iso_8601": "2024-05-16T14:48:00.510823Z",
"url": "https://files.pythonhosted.org/packages/5e/d7/850f54c925215fbca7db501c94805539702238e56522e0d4111b8f2a5ab7/grote-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca95bcb40bbe2813ce6a59a08294e4e81744daa2d9411713cd789eacd8678a10",
"md5": "d686422d0fe2bf88e870373acee365fa",
"sha256": "2de872014b69ca5f4391525b2f132a81d01e78f24ba9522690476130c7c8d651"
},
"downloads": -1,
"filename": "grote-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "d686422d0fe2bf88e870373acee365fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 19691,
"upload_time": "2024-05-16T14:48:02",
"upload_time_iso_8601": "2024-05-16T14:48:02.389740Z",
"url": "https://files.pythonhosted.org/packages/ca/95/bcb40bbe2813ce6a59a08294e4e81744daa2d9411713cd789eacd8678a10/grote-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 14:48:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gsarti",
"github_project": "grote",
"github_not_found": true,
"lcname": "grote"
}
JSON
