-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add initial version query script and dataset
- Loading branch information
0 parents
commit 5ffdc12
Showing
8 changed files
with
22,411 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,187 @@ | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
share/python-wheels/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
MANIFEST | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.nox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
*.py,cover | ||
.hypothesis/ | ||
.pytest_cache/ | ||
cover/ | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
local_settings.py | ||
db.sqlite3 | ||
db.sqlite3-journal | ||
|
||
# Flask stuff: | ||
instance/ | ||
.webassets-cache | ||
|
||
# Scrapy stuff: | ||
.scrapy | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
.pybuilder/ | ||
target/ | ||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# IPython | ||
profile_default/ | ||
ipython_config.py | ||
|
||
# pyenv | ||
# For a library or package, you might want to ignore these files since the code is | ||
# intended to run in multiple environments; otherwise, check them in: | ||
# .python-version | ||
|
||
# pipenv | ||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. | ||
# However, in case of collaboration, if having platform-specific dependencies or dependencies | ||
# having no cross-platform support, pipenv may install dependencies that don't work, or not | ||
# install all needed dependencies. | ||
#Pipfile.lock | ||
|
||
# poetry | ||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. | ||
# This is especially recommended for binary packages to ensure reproducibility, and is more | ||
# commonly ignored for libraries. | ||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control | ||
#poetry.lock | ||
|
||
# pdm | ||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. | ||
#pdm.lock | ||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it | ||
# in version control. | ||
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control | ||
.pdm.toml | ||
.pdm-python | ||
.pdm-build/ | ||
|
||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm | ||
__pypackages__/ | ||
|
||
# Celery stuff | ||
celerybeat-schedule | ||
celerybeat.pid | ||
|
||
# SageMath parsed files | ||
*.sage.py | ||
|
||
# Environments | ||
.env | ||
.venv | ||
env/ | ||
venv/ | ||
ENV/ | ||
env.bak/ | ||
venv.bak/ | ||
|
||
# Spyder project settings | ||
.spyderproject | ||
.spyproject | ||
|
||
# Rope project settings | ||
.ropeproject | ||
|
||
# mkdocs documentation | ||
/site | ||
|
||
# mypy | ||
.mypy_cache/ | ||
.dmypy.json | ||
dmypy.json | ||
|
||
# Pyre type checker | ||
.pyre/ | ||
|
||
# pytype static type analyzer | ||
.pytype/ | ||
|
||
# Cython debug symbols | ||
cython_debug/ | ||
|
||
# PyCharm | ||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can | ||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore | ||
# and can be added to the global gitignore or merged into this file. For a more nuclear | ||
# option (not recommended) you can uncomment the following to ignore the entire idea folder. | ||
#.idea/ | ||
|
||
.vscode/* | ||
!.vscode/settings.json | ||
!.vscode/tasks.json | ||
!.vscode/launch.json | ||
!.vscode/extensions.json | ||
!.vscode/*.code-snippets | ||
|
||
# Local History for Visual Studio Code | ||
.history/ | ||
|
||
# Built Visual Studio Code Extensions | ||
*.vsix | ||
|
||
# Virtualenv | ||
# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ | ||
.Python | ||
[Bb]in | ||
[Ii]nclude | ||
[Ll]ib | ||
[Ll]ib64 | ||
[Ll]ocal | ||
pyvenv.cfg | ||
.venv | ||
pip-selfcheck.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Contributing Guidelines | ||
|
||
Thank you for your interest in contributing to this project! We welcome and appreciate any contributions, whether they are bug reports, feature requests, or code contributions. By following these guidelines, you can help make the contribution process smooth and effective for everyone involved. | ||
|
||
## Getting Started | ||
|
||
1. Fork the repository and create a new branch for your contributions. | ||
2. Make sure your code follows the project's coding style and conventions. | ||
3. Write clear and concise commit messages. | ||
4. Submit a pull request with a clear description of the changes you've made. | ||
|
||
## Reporting Issues | ||
|
||
If you encounter any issues or have feature requests, please create a new issue on the project's issue tracker. Provide a clear and concise description of the problem or feature request, along with any relevant information or code examples. | ||
|
||
## Contributing Code | ||
|
||
1. Follow the project's coding style and conventions. | ||
2. Write clear and concise commit messages. | ||
3. Submit a pull request with a clear description of the changes you've made. | ||
|
||
## License | ||
|
||
By contributing to this project, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE) file. | ||
|
||
Thank you for your contributions! We appreciate your efforts in making this project better. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Javad Razi <[email protected]> | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# English to Persian Wikipedia Translations of Technical Terms | ||
|
||
## Overview | ||
|
||
This repository aims to create a comprehensive dataset that maps technical terms and concepts between English and Persian (Farsi) Wikipedia. The focus is primarily on fields such as Computer Science, Artificial Intelligence, Software Engineering, and Bio-Medical Engineering. | ||
|
||
## Objectives | ||
|
||
- **Mapping Technical Terms**: Identify and map key technical terms and concepts from English Wikipedia to their corresponding entries in Persian Wikipedia. | ||
- **Contextual Information**: Include keywords and descriptions to provide context for each term or concept. | ||
- **Resource Creation**: Develop a resource to aid people in writing seminar papers and theses in Persian, which there is usually strict requirements for using Persian terms. For fields like Computer Science, where there are a ton of English terms and their Persian translations are not always clear, this dataset can relieve some of the pain of finding the right Persian term for a given English term. | ||
|
||
## Project Structure | ||
|
||
``` | ||
en-fa-wikipedia-translations/ | ||
│ | ||
├── data/ | ||
│ ├── dataset.csv | ||
│ ├── dataset.tsv | ||
│ ├── dataset.json | ||
│ | ||
├── scripts/ | ||
│ ├── query.sparql | ||
│ | ||
|── CONTRIBUTING.md | ||
├── .gitignore | ||
├── LICENSE | ||
├── README.md | ||
``` | ||
|
||
## Accessing The Data | ||
|
||
The datasets are readily available in the `data/` directory. Furthermore, you can use the SPARQL query in the `./scripts/query.sparql` file to fetch the data directly from the Wikidata Query Service. | ||
|
||
## Dataset Structure | ||
|
||
The dataset will include the following fields: | ||
|
||
- **English Term**: The term in English. | ||
- **Persian Term**: The corresponding term in Persian. | ||
- **Description (EN)**: A brief description of the term in English. | ||
- **Description (FA)**: A brief description of the term in Persian. | ||
- **Source URL (EN)**: The URL of the English Wikipedia entry. | ||
- **Source URL (FA)**: The URL of the Persian Wikipedia entry. | ||
|
||
## TODO | ||
|
||
- [ ] Automate the process of fetching the data from the Wikidata Query Service and updating the dataset. | ||
- [ ] Optimize the SPARQL query both in terms of performance and the quality of the results. | ||
- [ ] Review the mappings to correct any potential inconsistencies or unwanted results. | ||
- [ ] Integrate the dataset with other curated datasets for Persian equivalents of technical terms, to create a more comprehensive resource. | ||
- [ ] Add workflow to automatically update the dataset with new terms and mappings. | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! To contribute, fork the repository and create a new branch. Make your changes and submit a pull request. For more details, see the [CONTRIBUTING](CONTRIBUTING.md) file. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. | ||
|
||
## Contact | ||
|
||
If you have any questions, suggestions, or feedback, feel free to open an issue or contact me at [[email protected]](mailto:[email protected]). |
Oops, something went wrong.