Metadata-Version: 2.1
Name: cld3-py
Version: 3.1.0
Summary: Compact Language Detector v3 (CLD3) Python bindings — modernised fork with prebuilt wheels for Python 3.10–3.14.
Keywords: language-detection,nlp,cld3,language-identification
Author: Malte Ostendorff
License: Copyright 2016 Google Inc.  All rights reserved.
         
                                          Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
         
            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
         
            1. Definitions.
         
               "License" shall mean the terms and conditions for use, reproduction,
               and distribution as defined by Sections 1 through 9 of this document.
         
               "Licensor" shall mean the copyright owner or entity authorized by
               the copyright owner that is granting the License.
         
               "Legal Entity" shall mean the union of the acting entity and all
               other entities that control, are controlled by, or are under common
               control with that entity. For the purposes of this definition,
               "control" means (i) the power, direct or indirect, to cause the
               direction or management of such entity, whether by contract or
               otherwise, or (ii) ownership of fifty percent (50%) or more of the
               outstanding shares, or (iii) beneficial ownership of such entity.
         
               "You" (or "Your") shall mean an individual or Legal Entity
               exercising permissions granted by this License.
         
               "Source" form shall mean the preferred form for making modifications,
               including but not limited to software source code, documentation
               source, and configuration files.
         
               "Object" form shall mean any form resulting from mechanical
               transformation or translation of a Source form, including but
               not limited to compiled object code, generated documentation,
               and conversions to other media types.
         
               "Work" shall mean the work of authorship, whether in Source or
               Object form, made available under the License, as indicated by a
               copyright notice that is included in or attached to the work
               (an example is provided in the Appendix below).
         
               "Derivative Works" shall mean any work, whether in Source or Object
               form, that is based on (or derived from) the Work and for which the
               editorial revisions, annotations, elaborations, or other modifications
               represent, as a whole, an original work of authorship. For the purposes
               of this License, Derivative Works shall not include works that remain
               separable from, or merely link (or bind by name) to the interfaces of,
               the Work and Derivative Works thereof.
         
               "Contribution" shall mean any work of authorship, including
               the original version of the Work and any modifications or additions
               to that Work or Derivative Works thereof, that is intentionally
               submitted to Licensor for inclusion in the Work by the copyright owner
               or by an individual or Legal Entity authorized to submit on behalf of
               the copyright owner. For the purposes of this definition, "submitted"
               means any form of electronic, verbal, or written communication sent
               to the Licensor or its representatives, including but not limited to
               communication on electronic mailing lists, source code control systems,
               and issue tracking systems that are managed by, or on behalf of, the
               Licensor for the purpose of discussing and improving the Work, but
               excluding communication that is conspicuously marked or otherwise
               designated in writing by the copyright owner as "Not a Contribution."
         
               "Contributor" shall mean Licensor and any individual or Legal Entity
               on behalf of whom a Contribution has been received by Licensor and
               subsequently incorporated within the Work.
         
            2. Grant of Copyright License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               copyright license to reproduce, prepare Derivative Works of,
               publicly display, publicly perform, sublicense, and distribute the
               Work and such Derivative Works in Source or Object form.
         
            3. Grant of Patent License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               (except as stated in this section) patent license to make, have made,
               use, offer to sell, sell, import, and otherwise transfer the Work,
               where such license applies only to those patent claims licensable
               by such Contributor that are necessarily infringed by their
               Contribution(s) alone or by combination of their Contribution(s)
               with the Work to which such Contribution(s) was submitted. If You
               institute patent litigation against any entity (including a
               cross-claim or counterclaim in a lawsuit) alleging that the Work
               or a Contribution incorporated within the Work constitutes direct
               or contributory patent infringement, then any patent licenses
               granted to You under this License for that Work shall terminate
               as of the date such litigation is filed.
         
            4. Redistribution. You may reproduce and distribute copies of the
               Work or Derivative Works thereof in any medium, with or without
               modifications, and in Source or Object form, provided that You
               meet the following conditions:
         
               (a) You must give any other recipients of the Work or
                   Derivative Works a copy of this License; and
         
               (b) You must cause any modified files to carry prominent notices
                   stating that You changed the files; and
         
               (c) You must retain, in the Source form of any Derivative Works
                   that You distribute, all copyright, patent, trademark, and
                   attribution notices from the Source form of the Work,
                   excluding those notices that do not pertain to any part of
                   the Derivative Works; and
         
               (d) If the Work includes a "NOTICE" text file as part of its
                   distribution, then any Derivative Works that You distribute must
                   include a readable copy of the attribution notices contained
                   within such NOTICE file, excluding those notices that do not
                   pertain to any part of the Derivative Works, in at least one
                   of the following places: within a NOTICE text file distributed
                   as part of the Derivative Works; within the Source form or
                   documentation, if provided along with the Derivative Works; or,
                   within a display generated by the Derivative Works, if and
                   wherever such third-party notices normally appear. The contents
                   of the NOTICE file are for informational purposes only and
                   do not modify the License. You may add Your own attribution
                   notices within Derivative Works that You distribute, alongside
                   or as an addendum to the NOTICE text from the Work, provided
                   that such additional attribution notices cannot be construed
                   as modifying the License.
         
               You may add Your own copyright statement to Your modifications and
               may provide additional or different license terms and conditions
               for use, reproduction, or distribution of Your modifications, or
               for any such Derivative Works as a whole, provided Your use,
               reproduction, and distribution of the Work otherwise complies with
               the conditions stated in this License.
         
            5. Submission of Contributions. Unless You explicitly state otherwise,
               any Contribution intentionally submitted for inclusion in the Work
               by You to the Licensor shall be under the terms and conditions of
               this License, without any additional terms or conditions.
               Notwithstanding the above, nothing herein shall supersede or modify
               the terms of any separate license agreement you may have executed
               with Licensor regarding such Contributions.
         
            6. Trademarks. This License does not grant permission to use the trade
               names, trademarks, service marks, or product names of the Licensor,
               except as required for reasonable and customary use in describing the
               origin of the Work and reproducing the content of the NOTICE file.
         
            7. Disclaimer of Warranty. Unless required by applicable law or
               agreed to in writing, Licensor provides the Work (and each
               Contributor provides its Contributions) on an "AS IS" BASIS,
               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
               implied, including, without limitation, any warranties or conditions
               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
               PARTICULAR PURPOSE. You are solely responsible for determining the
               appropriateness of using or redistributing the Work and assume any
               risks associated with Your exercise of permissions under this License.
         
            8. Limitation of Liability. In no event and under no legal theory,
               whether in tort (including negligence), contract, or otherwise,
               unless required by applicable law (such as deliberate and grossly
               negligent acts) or agreed to in writing, shall any Contributor be
               liable to You for damages, including any direct, indirect, special,
               incidental, or consequential damages of any character arising as a
               result of this License or out of the use or inability to use the
               Work (including but not limited to damages for loss of goodwill,
               work stoppage, computer failure or malfunction, or any and all
               other commercial damages or losses), even if such Contributor
               has been advised of the possibility of such damages.
         
            9. Accepting Warranty or Additional Liability. While redistributing
               the Work or Derivative Works thereof, You may choose to offer,
               and charge a fee for, acceptance of support, warranty, indemnity,
               or other liability obligations and/or rights consistent with this
               License. However, in accepting such obligations, You may act only
               on Your own behalf and on Your sole responsibility, not on behalf
               of any other Contributor, and only if You agree to indemnify,
               defend, and hold each Contributor harmless for any liability
               incurred by, or claims asserted against, such Contributor by reason
               of your accepting any such warranty or additional liability.
         
            END OF TERMS AND CONDITIONS
         
            APPENDIX: How to apply the Apache License to your work.
         
               To apply the Apache License to your work, attach the following
               boilerplate notice, with the fields enclosed by brackets "[]"
               replaced with your own identifying information. (Don't include
               the brackets!)  The text should be enclosed in the appropriate
               comment syntax for the file format. We also recommend that a
               file or class name and description of purpose be included on the
               same "printed page" as the copyright notice for easier
               identification within third-party archives.
         
            Copyright 2016, Google Inc.
         
            Licensed under the Apache License, Version 2.0 (the "License");
            you may not use this file except in compliance with the License.
            You may obtain a copy of the License at
         
                http://www.apache.org/licenses/LICENSE-2.0
         
            Unless required by applicable law or agreed to in writing, software
            distributed under the License is distributed on an "AS IS" BASIS,
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            See the License for the specific language governing permissions and
            limitations under the License.
         
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Text Processing :: Linguistic
Project-URL: Homepage, https://github.com/malteos/cld3
Project-URL: Repository, https://github.com/malteos/cld3
Project-URL: Issues, https://github.com/malteos/cld3/issues
Project-URL: Changelog, https://github.com/malteos/cld3/blob/master/CHANGELOG.md
Requires-Python: >=3.10
Provides-Extra: test
Requires-Dist: pytest>=8; extra == "test"
Description-Content-Type: text/markdown

# Compact Language Detector v3 (CLD3) — Python bindings

[![PyPI](https://img.shields.io/pypi/v/cld3-py.svg)](https://pypi.org/project/cld3-py/)
[![Python Versions](https://img.shields.io/pypi/pyversions/cld3-py.svg)](https://pypi.org/project/cld3-py/)

Modernised Python bindings for Google's CLD3 neural language detector, distributed on PyPI as
[`cld3-py`](https://pypi.org/project/cld3-py/). Prebuilt wheels are published for:

| Platform                | Architectures                   |
| ----------------------- | ------------------------------- |
| Linux (manylinux_2_28)  | `x86_64`, `aarch64`             |
| Linux (musllinux_1_2)   | `x86_64`, `aarch64`             |
| macOS                   | `x86_64` (Intel), `arm64` (Apple Silicon) |
| Windows                 | `AMD64`                         |

Supported Python versions: **3.10, 3.11, 3.12, 3.13, 3.14** (including free-threaded `cp313t` / `cp314t` builds).

## Install

```shell
pip install cld3-py
```

## Quick start

The import name is `gcld3`, so code written against the original Google `gcld3` package works unchanged:

```python
import gcld3

detector = gcld3.NNetLanguageIdentifier(min_num_bytes=0, max_num_bytes=1000)

result = detector.FindLanguage(text="This text is written in English.")
print(result.language)     # "en"
print(result.probability)  # ~0.999
print(result.is_reliable)  # True
print(result.proportion)   # 1.0

# Multiple languages in the same document:
sample = "This piece of text is in English. Този текст е на Български."
for r in detector.FindTopNMostFreqLangs(text=sample, num_langs=2):
    print(r.language, r.probability, r.proportion)
```

### Drop-in replacement for `gcld3`

If you are migrating from the old PyPI `gcld3` package:

```shell
pip uninstall gcld3
pip install cld3-py
# No code changes required — `import gcld3` still works.
```

## Table of contents

* [Model](#model)
* [Supported Languages](#supported-languages)
* [Building from source](#building-from-source)
* [Verification / parity](#verification--parity)
* [Bugs and Feature Requests](#bugs-and-feature-requests)
* [Credits](#credits)

### Model

CLD3 is a neural network model for language identification. This package
 contains the inference code and a trained model. The inference code
 extracts character ngrams from the input text and computes the fraction
 of times each of them appears. For example, as shown in the figure below,
 if the input text is "banana", then one of the extracted trigrams is "ana"
 and the corresponding fraction is 2/4. The ngrams are hashed down to an id
 within a small range, and each id is represented by a dense embedding vector
 estimated during training.

The model averages the embeddings corresponding to each ngram type according
 to the fractions, and the averaged embeddings are concatenated to produce
 the embedding layer. The remaining components of the network are a hidden
 (Rectified linear) layer and a softmax layer.

To get a language prediction for the input text, we simply perform a forward
 pass through the network.

![Figure](model.png "CLD3")

### Supported Languages

The model outputs BCP-47-style language codes, shown in the table below. For
some languages, output is differentiated by script. Language and script names
from
[Unicode CLDR](https://github.com/unicode-cldr/cldr-localenames-modern/blob/master/main/en).

Output Code | Language Name   | Script Name
----------- | --------------- | ------------------------------------------
af          | Afrikaans       | Latin
am          | Amharic         | Ethiopic
ar          | Arabic          | Arabic
bg          | Bulgarian       | Cyrillic
bg-Latn     | Bulgarian       | Latin
bn          | Bangla          | Bangla
bs          | Bosnian         | Latin
ca          | Catalan         | Latin
ceb         | Cebuano         | Latin
co          | Corsican        | Latin
cs          | Czech           | Latin
cy          | Welsh           | Latin
da          | Danish          | Latin
de          | German          | Latin
el          | Greek           | Greek
el-Latn     | Greek           | Latin
en          | English         | Latin
eo          | Esperanto       | Latin
es          | Spanish         | Latin
et          | Estonian        | Latin
eu          | Basque          | Latin
fa          | Persian         | Arabic
fi          | Finnish         | Latin
fil         | Filipino        | Latin
fr          | French          | Latin
fy          | Western Frisian | Latin
ga          | Irish           | Latin
gd          | Scottish Gaelic | Latin
gl          | Galician        | Latin
gu          | Gujarati        | Gujarati
ha          | Hausa           | Latin
haw         | Hawaiian        | Latin
hi          | Hindi           | Devanagari
hi-Latn     | Hindi           | Latin
hmn         | Hmong           | Latin
hr          | Croatian        | Latin
ht          | Haitian Creole  | Latin
hu          | Hungarian       | Latin
hy          | Armenian        | Armenian
id          | Indonesian      | Latin
ig          | Igbo            | Latin
is          | Icelandic       | Latin
it          | Italian         | Latin
iw          | Hebrew          | Hebrew
ja          | Japanese        | Japanese
ja-Latn     | Japanese        | Latin
jv          | Javanese        | Latin
ka          | Georgian        | Georgian
kk          | Kazakh          | Cyrillic
km          | Khmer           | Khmer
kn          | Kannada         | Kannada
ko          | Korean          | Korean
ku          | Kurdish         | Latin
ky          | Kyrgyz          | Cyrillic
la          | Latin           | Latin
lb          | Luxembourgish   | Latin
lo          | Lao             | Lao
lt          | Lithuanian      | Latin
lv          | Latvian         | Latin
mg          | Malagasy        | Latin
mi          | Maori           | Latin
mk          | Macedonian      | Cyrillic
ml          | Malayalam       | Malayalam
mn          | Mongolian       | Cyrillic
mr          | Marathi         | Devanagari
ms          | Malay           | Latin
mt          | Maltese         | Latin
my          | Burmese         | Myanmar
ne          | Nepali          | Devanagari
nl          | Dutch           | Latin
no          | Norwegian       | Latin
ny          | Nyanja          | Latin
pa          | Punjabi         | Gurmukhi
pl          | Polish          | Latin
ps          | Pashto          | Arabic
pt          | Portuguese      | Latin
ro          | Romanian        | Latin
ru          | Russian         | Cyrillic
ru-Latn     | Russian         | English
sd          | Sindhi          | Arabic
si          | Sinhala         | Sinhala
sk          | Slovak          | Latin
sl          | Slovenian       | Latin
sm          | Samoan          | Latin
sn          | Shona           | Latin
so          | Somali          | Latin
sq          | Albanian        | Latin
sr          | Serbian         | Cyrillic
st          | Southern Sotho  | Latin
su          | Sundanese       | Latin
sv          | Swedish         | Latin
sw          | Swahili         | Latin
ta          | Tamil           | Tamil
te          | Telugu          | Telugu
tg          | Tajik           | Cyrillic
th          | Thai            | Thai
tr          | Turkish         | Latin
uk          | Ukrainian       | Cyrillic
ur          | Urdu            | Arabic
uz          | Uzbek           | Latin
vi          | Vietnamese      | Latin
xh          | Xhosa           | Latin
yi          | Yiddish         | Hebrew
yo          | Yoruba          | Latin
zh          | Chinese         | Han (including Simplified and Traditional)
zh-Latn     | Chinese         | Latin
zu          | Zulu            | Latin

### Building from source

Most users should just `pip install cld3-py`. To build from source (e.g. for an unreleased Python version or
to work on the bindings):

```shell
git clone https://github.com/malteos/cld3
cd cld3
pip install -v .
```

The build uses `scikit-build-core` + CMake. Protobuf v3.21.12 is fetched and statically linked via CMake
`FetchContent`, so no system `protoc` / `libprotobuf` is required.

To additionally build the reference C++ CLI binaries:

```shell
cmake -S . -B build -DCLD3_BUILD_TOOLS=ON
cmake --build build -j
./build/language_identifier_main
```

### Verification / parity

A parity test (`tests/test_parity.py`) verifies that the Python bindings produce the same predictions as the
original C++ reference for ~75 multilingual samples. Run it locally with:

```shell
cmake -S . -B build -DCLD3_BUILD_TOOLS=ON && cmake --build build -j
CLD3_PARITY_BINARY=$PWD/build/parity_runner pytest tests/test_parity.py -v
```

The same test runs in CI after every wheel build.

### Bugs and Feature Requests

Open a [GitHub issue](https://github.com/google/cld3/issues) for this repository to file bugs and feature requests.

### Announcements and Discussion

For announcements regarding major updates as well as general discussion list, please subscribe to:
[cld3-users@googlegroups.com](https://groups.google.com/forum/#!forum/cld3-users)

### Credits

Original authors of the code in this package include (in alphabetical order):

* Alex Salcianu
* Andy Golding
* Anton Bakalov
* Chris Alberti
* Daniel Andor
* David Weiss
* Emily Pitler
* Greg Coppola
* Jason Riesa
* Kuzman Ganchev
* Michael Ringgaard
* Nan Hua
* Ryan McDonald
* Slav Petrov
* Stefan Istrate
* Terry Koo
