Welcome to the Panlingo repository! π
This project presents a comprehensive collection of language identification libraries for .NET. Its primary purpose is to bring popular language identification models to the .NET ecosystem, allowing developers to seamlessly integrate language detection functionality into their applications.
Model | Authors | License | Original source code | Wrapper docs |
---|---|---|---|---|
CLD2 | Google, Inc. | Apache-2.0 | @CLD2Owners/cld2 | link |
CLD3 | Google, Inc. | Apache-2.0 | @google/cld3 | link |
FastText | Meta Platforms, Inc. | MIT | @facebookresearch/fastText | link |
Whatlang | Serhii Potapov | MIT | @greyblake/whatlang-rs | link |
MediaPipe | Google, Inc. | Apache-2.0 | @google-ai-edge/mediapipe | link |
Lingua | Peter M. Stahl | Apache-2.0 | @pemistahl/lingua-rs | link |
- Zero-dependency development.
- The original code of libraries (CLD2, CLD3, FastText, MediaPipe) is used as submodules without additional significant modifications or improvements (except for a small monkey-patching π). Third-party code is not included into this repository.
- Preserve the original library behavior without breaking changes.
Feature | CLD2 | CLD3 | FastText* | Whatlang | MediaPipe** | Lingua |
---|---|---|---|---|---|---|
Single language prediction | Yes | Yes | Yes | Yes | Yes | Yes |
Multi language prediction | Yes | Yes | Yes | No | Yes | Yes |
Supported languages | 83 | 107 | 176 or 217 | 69 | 110 | 75 |
Unknown language detection | Yes | Yes | No | No | Yes | No |
Algorithm | quadgrams | neural network | neural network | trigrams | neural network | trigrams |
Script detection | No | No | Yes (only lid218e) | Yes | No | No |
Written in | C++ | C++ | C++ | Rust | C++ | Rust |
* When using these models: lid176, lid218e
** When using MediaPipe Language Detector
Model | Linux | Windows | macOS |
---|---|---|---|
CLD2 | β | β | β |
CLD3 | β | β | β |
FastText | β | β | β |
Whatlang | β | β | β |
MediaPipe | β | β | β * |
Lingua | β | β | β * |
β β Full support | β β No support | π§ β Under research
* arm64 CPU only (Apple silicon M series)
We welcome contributions from developers of all skill levels. Whether you're fixing a bug, adding a new feature, or improving documentation, we appreciate your help in making this project better.
To get started with contributing, follow these simple steps:
-
Clone the Repository
First, clone the repository to your local machine with the following command:
git clone --recurse-submodules --remote-submodules https://github.com/gluschenko/panlingo.git
-
Create a Branch
Before you start making changes, create a new branch to keep your work organized. Use a descriptive name for your branch to make it easy to understand its purpose:
git checkout -b feature/your-feature-name
-
Make Changes
Now, you can make changes to the codebase. Please ensure your code follows our project's coding standards and includes relevant tests if applicable.
-
Commit Your Changes
Once you've made your changes, commit them with a clear and informative commit message:
git add . git commit -m "Add description of your changes"
-
Push Your Changes
Push your branch to the remote repository:
git push origin feature/your-feature-name
-
Build
Each library project in the solution has four configurations:
ReleaseLinuxOnly
,DebugLinuxOnly
,Release
, andDebug
.- The
ReleaseLinuxOnly
andDebugLinuxOnly
configurations are for building on a local Linux or Windows machine (WSL is supported as well). It produces native binaries only for Linux. - The
Release
andDebug
configurations are intended for cross-platform builds, which are only supported in CI/CD environments like GitHub Actions.
Here's how you can build the projects on a local Linux machine.
Requirements:
- Windows 10 or higher.
- WSL2 set up for simulating a Linux environment.
- Docker Desktop for container management.
- 45GB+ of free disk space for storing Docker images.
- Modern CPU with AVX support for optimal performance.
To build the entire solution:
cd src dotnet build -c ReleaseLinuxOnly
To build a specific library:
cd src/LanguageIdentification.FastText.Native dotnet build -c ReleaseLinuxOnly cd src/LanguageIdentification.FastText dotnet build -c ReleaseLinuxOnly
- The
-
Test
To execute the test project on Linux or Windows, follow these instructions:
-
Linux:
For Linux systems, access the test project's directory and execute:
cd src/LanguageIdentification.Tests dotnet test -c ReleaseLinuxOnly
-
Windows:
On Windows, you can utilize WSL to run the test project. Do so by:
cd src/LanguageIdentification.Tests wsl -d Ubuntu -e bash -c "dotnet test -c ReleaseLinuxOnly"
-
Docker:
Also you can run test project inside Docker-container on every supported platform (see run-tests.ps1 and run-tests.sh):
cd src docker build --file test.Dockerfile -t panlingo-test-image . docker container create --name panlingo-test-runner -v "${PWD}:/src" -i panlingo-test-image docker container start panlingo-test-runner docker exec panlingo-test-runner sh -c "cd /src && dotnet test -c ReleaseLinuxOnly -l 'console;verbosity=detailed'"
-
-
Run
To run the test project on either Linux or Windows, use the following steps:
-
Linux:
If you're on a Linux OS, navigate to the directory of the test project and run:
cd src/LanguageIdentification.FastText.ConsoleTest dotnet run -c ReleaseLinuxOnly
-
Windows:
For Windows users, you can employ WSL to execute the test project by executing:
cd src/LanguageIdentification.FastText.ConsoleTest wsl -d Ubuntu -e bash -c "dotnet run -c ReleaseLinuxOnly"
-
-
Open a Pull Request
Navigate to the repository on GitHub and open a pull request. Provide a detailed description of your changes and any additional information that might help reviewers understand your contribution.
After opening a pull request, it will be reviewed by one of the project maintainers. Feedback and suggestions might be provided to ensure the code meets our quality standards. Once approved, your changes will be merged into the main branch.
Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
This project is licensed under the MIT License Β© 2024β2025 Alexander Gluschenko.
Includes software from the following project(s):
- CLD2 β Β© 2013 Google Inc., licensed under Apache-2.0
- CLD3 β Β© 2016 Google Inc., licensed under Apache-2.0
- FastText β Β© 2016βpresent Meta Platforms, Inc., licensed under MIT
- Lingua β Β© 2020β2023 Peter M. Stahl, licensed under Apache-2.0
- MediaPipe Language Detector β Β© 2023β2025 Google Inc., licensed under Apache-2.0
- Whatlang β Β© 2017 Serhii Potapov and others, licensed under MIT
See the LICENSE file for full details.
Happy hacking! π©βπ»π¨βπ»