Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Azure/co-op-translator
Easily generate multilingual translations for your project with a single command, powered by Azure AI Services.
https://github.com/Azure/co-op-translator
azure azure-computer-vision azure-openai co-op-translator image-translation localization markdown-translation multilingual-translation open-source python-package
Last synced: about 2 months ago
JSON representation
Easily generate multilingual translations for your project with a single command, powered by Azure AI Services.
- Host: GitHub
- URL: https://github.com/Azure/co-op-translator
- Owner: Azure
- License: mit
- Created: 2024-09-19T08:51:34.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-19T11:41:58.000Z (2 months ago)
- Last Synced: 2024-12-04T18:42:39.999Z (about 2 months ago)
- Topics: azure, azure-computer-vision, azure-openai, co-op-translator, image-translation, localization, markdown-translation, multilingual-translation, open-source, python-package
- Language: Python
- Homepage: https://techcommunity.microsoft.com/t5/educator-developer-blog/automate-markdown-and-image-translations-using-co-op-translator/ba-p/4263474
- Size: 59.7 MB
- Stars: 159
- Watchers: 6
- Forks: 11
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
- StarryDivineSky - Azure/co-op-translator - op-translator 是一个 Python 包，利用 Azure AI 服务的先进语言模型技术，通过单个命令轻松生成多语言翻译，简化项目多语言化过程，支持 Markdown 文件和图片中的文本翻译，易于集成到现有项目中，简化本地化流程。 (A01_文本生成_文本对话 / 其他_文本生成_文本对话)
README
# Co-op Translator: Localize Your Project with a Single Command
_Easily generate multilingual translations for your project with a single command, powered by Azure AI Services._
[](https://pypi.org/project/co-op-translator/)
[](https://github.com/azure/co-op-translator/blob/main/LICENSE)
[](https://pepy.tech/project/co-op-translator)
[](https://pepy.tech/project/co-op-translator)
[](https://GitHub.com/azure/co-op-translator/graphs/contributors/)
[](https://GitHub.com/azure/co-op-translator/issues/)
[](https://GitHub.com/azure/co-op-translator/pulls/)
[](http://makeapullrequest.com)
[](https://GitHub.com/azure/co-op-translator/watchers/)
[](https://GitHub.com/azure/co-op-translator/network/)
[](https://GitHub.com/azure/co-op-translator/stargazers/)
[](https://codespaces.new/azure/co-op-translator)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure/co-op-translator)
## 🌐 Overview
**Co-op Translator** is a Python package designed to automate multilingual translations for your projects using advanced Large Language Model (LLM) technology and Azure AI Services. This project aims to simplify the process of translating content into multiple languages, making it accessible and efficient for developers.
By integrating Co-op Translator into your workflow, you can automatically generate organized translation folders for different languages, and translate both Markdown files and images effortlessly.
Here is an example of how Co-op Translator structures the translations and translates both Markdown files and text within images in your project:
**Ready to unlock multilingual accessibility? Get started with Co-op Translator today!**
## ✨ Key features
- **Automated Translations**: Translate text into multiple languages effortlessly.
- **Markdown Preservation**: Maintain correct Markdown syntax during translation.
- **Image Text Translation**: Extract and translate text within images.
- **Advanced LLM Technology**: Utilize cutting-edge language models for high-quality translations.
- **Easy Integration**: Seamlessly integrate with your existing project setup.
- **Simplify Localization**: Streamline the process of localizing your project for international markets.
## 🌉 Bridging the language gap in tech
English is often considered the universal language of technology, but many developers worldwide are non-native English speakers. This can create barriers in accessing and contributing to technical projects.
**Co-op Translator** aims to break down these language barriers by providing an easy-to-use tool for automating translations. By making technical documentation accessible in multiple languages, we empower developers, students, and researchers globally.
## ⭐ Support us
Join us in revolutionizing global communication! Give a ⭐ to [Co-op Translator](https://github.com/azure/co-op-translator) on GitHub and help us break down language barriers together. Your support makes a difference!
## ⚙️ How it works
The process begins with Markdown and image files from your project folder, which are processed by **Azure AI Services**:
- **Azure OpenAI**: Translates text from Markdown files.
- **Azure Computer Vision**: Extracts text from images, which are then translated by Azure OpenAI.
The final translated Markdown and image files are saved in the designated translation folder, ready to be used in multiple languages.
## 🚀 Getting started with Co-op Translator
### Prerequisites
- Azure Computer vision resource
- Azure OpenAI resource
- Python 3.10 or higher
### Quick install
#### Install via pip
```bash
pip install co-op-translator
```
#### Install via poetry
```bash
poetry add co-op-translator
```
### How to use Co-op Translator
1. [Set up Azure resources before starting](./getting_started/set-up-azure-resources.md)
1. [Create an '.env' file in the root directory](./getting_started/create-env-file.md)
1. [Install the Co-op translator package](./getting_started/install-package.md)
1. [Translate your project using Co-op Translator](./getting_started/translator-your-project.md)
### Additional resources
- [Command reference](./getting_started/command-reference.md): Learn about all available commands and their options in detail.
- [Multi-language support setup](./getting_started/multi-language-support.md): Before starting the translation process, you can add a table in the README that links to the translated versions of your document.
- [Supported Languages](./getting_started/supported-languages.md): Check the list of supported languages and instructions to add new languages.
## 📚 Case Studies: Applying Co-op Translator in real projects
These case studies show how Co-op Translator was applied to translate a real-world project. It highlights the translation process, the challenges encountered, and the results achieved, providing a useful reference for applying the tool to similar projects.
1. [Phi-3 Cookbook translation: A case study](./getting_started/Phi-3Cookbook-translation-case.md)
## 🎥 Video presentations
Learn more about Co-op Translator through our presentations _(Click the image below to watch on YouTube.)_:
- **Open at Microsoft**: A brief 18-minute introduction and quick guide on how to use Co-op Translator.
[](https://www.youtube.com/watch?v=jX_swfH_KNU)
- **Microsoft Reactor** (Scheduled for December 2, 2024): A one-hour detailed step-by-step guide covering everything from understanding what Co-op Translator is, setting up the tool, and using it effectively, to a live demo showcasing its capabilities in action.
[](https://www.youtube.com/watch?v=boTtKVPBLAc)
## Contributing
This project welcomes contributions and suggestions. Interested in contributing to Azure Co-op Translator? Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how you can help make Co-op Translator more accessible.
## Contributors
[](https://github.com/Azure/co-op-translator/graphs/contributors)
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## Responsible AI
Microsoft is committed to helping our customers use our AI products responsibly, sharing our learnings, and building trust-based partnerships through tools like Transparency Notes and Impact Assessments. Many of these resources can be found at [https://aka.ms/RAI](https://aka.ms/RAI).
Microsoft’s approach to responsible AI is grounded in our AI principles of fairness, reliability and safety, privacy and security, inclusiveness, transparency, and accountability.
Large-scale natural language, image, and speech models - like the ones used in this sample - can potentially behave in ways that are unfair, unreliable, or offensive, in turn causing harms. Please consult the [Azure OpenAI service Transparency note](https://learn.microsoft.com/legal/cognitive-services/openai/transparency-note?tabs=text) to be informed about risks and limitations.
The recommended approach to mitigating these risks is to include a safety system in your architecture that can detect and prevent harmful behavior. [Azure AI Content Safety](https://learn.microsoft.com/azure/ai-services/content-safety/overview) provides an independent layer of protection, able to detect harmful user-generated and AI-generated content in applications and services. Azure AI Content Safety includes text and image APIs that allow you to detect material that is harmful. We also have an interactive Content Safety Studio that allows you to view, explore and try out sample code for detecting harmful content across different modalities. The following [quickstart documentation](https://learn.microsoft.com/azure/ai-services/content-safety/quickstart-text?tabs=visual-studio%2Clinux&pivots=programming-language-rest) guides you through making requests to the service.
Another aspect to take into account is the overall application performance. With multi-modal and multi-models applications, we consider performance to mean that the system performs as you and your users expect, including not generating harmful outputs. It's important to assess the performance of your overall application using [generation quality and risk and safety metrics](https://learn.microsoft.com/azure/ai-studio/concepts/evaluation-metrics-built-in).
You can evaluate your AI application in your development environment using the [prompt flow SDK](https://microsoft.github.io/promptflow/index.html). Given either a test dataset or a target, your generative AI application generations are quantitatively measured with built-in evaluators or custom evaluators of your choice. To get started with the prompt flow sdk to evaluate your system, you can follow the [quickstart guide](https://learn.microsoft.com/azure/ai-studio/how-to/develop/flow-evaluate-sdk). Once you execute an evaluation run, you can [visualize the results in Azure AI Studio](https://learn.microsoft.com/azure/ai-studio/how-to/evaluate-flow-results).
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.