build based on 159467b

dev/index.html

@@ -9,4 +9,4 @@
 Precompiling project...
 <span class="sgr33">  ✓ </span>LanguageIdentification
   1 dependency successfully precompiled in 1 seconds. 8 already precompiled.
-  <span class="sgr33">1</span> dependency precompiled but a different version is currently loaded. Restart julia to access the new version</code></pre><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.initialize-Tuple{}" href="#LanguageIdentification.initialize-Tuple{}"><code>LanguageIdentification.initialize</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">initialize(; languages=supported_languages(), ngram=1:4, cutoff=0.85, vocabulary=1000:5000)</code></pre><p>Initialize the language detector with the given parameters. Different parameters have different balances among accuracy, speed, and memory usage. </p><p><strong>Arguments</strong></p><ul><li><code>languages::Vector{String}</code>: A list of languages to be used for language detection. If this argument is not provided, all the languages returned by the <a href="#LanguageIdentification.supported_languages-Tuple{}"><code>supported_languages</code></a> function will be used.</li><li><code>ngram::Union{Int, AbstractVector}</code>: Specifies the length of UTF-8 byte n-grams to be utilized for language detection. An integer value can be provided to use a single n-gram size, while a range can be provided to use multiple n-gram sizes. The default value is <code>1:4</code>, and the maximum value allowed is <code>7</code>.</li><li><code>cutoff::Float64</code>: The cutoff value of the cumulative probability of the n-grams to use for language detection. The default value is <code>0.85</code>, and it must be between <code>0</code> and <code>1</code>.</li><li><code>vocabulary::Union{Int, AbstractRange}</code>: The size range of the vocabulary of each language. The default value is <code>1000:5000</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/35fbc60f1ece8f0383f5f9fe5819bec56cb6005d/src/detector.jl#L25-L35">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.langid-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}" href="#LanguageIdentification.langid-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}"><code>LanguageIdentification.langid</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">langid(text, languages::Vector{String}, profiles::Vector{Dict{Vector{UInt8}, Float32}}; ngram=NGRAM)</code></pre><p>Return the language of the given text based on the provided language profiles.</p><p><strong>Arguments</strong></p><ul><li><code>text</code>: A string or a collection of strings to be analyzed for language identification.</li><li><code>languages::Vector{String}</code>: The list of languages to choose from. Omitting this argument will use all supported languages.</li><li><code>profiles::Vector{Dict{Vector{UInt8}, Float32}}</code>: The language profiles to use for identification. Omitting this argument will use the default profiles.</li><li><code>ngram::Union{Int, AbstractVector}</code>: The length of utf-8 byte n-grams to use for language detection. The default value is the value set in <a href="#LanguageIdentification.initialize-Tuple{}"><code>initialize</code></a>, and should not exceed that value.</li></ul><p><strong>Returns</strong></p><ul><li>The language of the given text.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/35fbc60f1ece8f0383f5f9fe5819bec56cb6005d/src/detector.jl#L100-L112">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.langprob-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}" href="#LanguageIdentification.langprob-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}"><code>LanguageIdentification.langprob</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">langprob(text, languages::Vector{String}, profiles::Vector{Dict{Vector{UInt8}, Float32}}; topk=5, ngram=NGRAM)</code></pre><p>Returns the probability distribution of the language of the given text based on the provided language profiles.</p><p><strong>Arguments</strong></p><ul><li><code>text</code>: A string or a collection of strings to be analyzed for language identification.</li><li><code>languages::Vector{String}</code>: A list of languages to choose from. If this argument is not provided, all the languages returned by the <a href="#LanguageIdentification.supported_languages-Tuple{}"><code>supported_languages</code></a> function will be used.</li><li><code>profiles::Vector{Dict{Vector{UInt8}, Float32}}</code>: The language profiles to use for identification. If this argument is not provided, the default profiles will be used.</li><li><code>topk::Int</code>: The number of candidates to return. The default value is 5.</li><li><code>ngram::Union{Int, AbstractVector}</code>: The length of utf-8 byte n-grams to use for language detection. The default value is the value set in <a href="#LanguageIdentification.initialize-Tuple{}"><code>initialize</code></a>, and should not exceed that value.</li></ul><p><strong>Returns</strong></p><ul><li>A list of the <code>topk</code> languages and their probabilities.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/35fbc60f1ece8f0383f5f9fe5819bec56cb6005d/src/detector.jl#L128-L142">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.supported_languages-Tuple{}" href="#LanguageIdentification.supported_languages-Tuple{}"><code>LanguageIdentification.supported_languages</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">supported_languages() -&gt; Vector{String}</code></pre><p>Return a vector containing all the languages (ISO 639-3 codes) that are supported by this package. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/35fbc60f1ece8f0383f5f9fe5819bec56cb6005d/src/detector.jl#L10-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.vocabulary_sizes-Tuple{}" href="#LanguageIdentification.vocabulary_sizes-Tuple{}"><code>LanguageIdentification.vocabulary_sizes</code></a> — <span class="docstring-category">Method</span></header><section><div><p>The function <code>vocabulary_sizes()</code> returns the sizes of the vocabulary for each language that was loaded by the <a href="#LanguageIdentification.initialize-Tuple{}"><code>initialize</code></a> function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/35fbc60f1ece8f0383f5f9fe5819bec56cb6005d/src/detector.jl#L18-L20">source</a></section></article><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#LanguageIdentification.initialize-Tuple{}"><code>LanguageIdentification.initialize</code></a></li><li><a href="#LanguageIdentification.langid-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}"><code>LanguageIdentification.langid</code></a></li><li><a href="#LanguageIdentification.langprob-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}"><code>LanguageIdentification.langprob</code></a></li><li><a href="#LanguageIdentification.supported_languages-Tuple{}"><code>LanguageIdentification.supported_languages</code></a></li><li><a href="#LanguageIdentification.vocabulary_sizes-Tuple{}"><code>LanguageIdentification.vocabulary_sizes</code></a></li></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 10 September 2023 09:52">Sunday 10 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+  <span class="sgr33">1</span> dependency precompiled but a different version is currently loaded. Restart julia to access the new version</code></pre><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.initialize-Tuple{}" href="#LanguageIdentification.initialize-Tuple{}"><code>LanguageIdentification.initialize</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">initialize(; languages=supported_languages(), ngram=1:4, cutoff=0.85, vocabulary=1000:5000)</code></pre><p>Initialize the language detector with the given parameters. Different parameters have different balances among accuracy, speed, and memory usage. </p><p><strong>Arguments</strong></p><ul><li><code>languages::Vector{String}</code>: A list of languages to be used for language detection. If this argument is not provided, all the languages returned by the <a href="#LanguageIdentification.supported_languages-Tuple{}"><code>supported_languages</code></a> function will be used.</li><li><code>ngram::Union{Int, AbstractVector}</code>: Specifies the length of UTF-8 byte n-grams to be utilized for language detection. An integer value can be provided to use a single n-gram size, while a range can be provided to use multiple n-gram sizes. The default value is <code>1:4</code>, and the maximum value allowed is <code>7</code>.</li><li><code>cutoff::Float64</code>: The cutoff value of the cumulative probability of the n-grams to use for language detection. The default value is <code>0.85</code>, and it must be between <code>0</code> and <code>1</code>.</li><li><code>vocabulary::Union{Int, AbstractRange}</code>: The size range of the vocabulary of each language. The default value is <code>1000:5000</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/159467bef124b6a3146d79ba11aa7735d92f6278/src/detector.jl#L25-L35">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.langid-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}" href="#LanguageIdentification.langid-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}"><code>LanguageIdentification.langid</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">langid(text, languages::Vector{String}, profiles::Vector{Dict{Vector{UInt8}, Float32}}; ngram=NGRAM)</code></pre><p>Return the language of the given text based on the provided language profiles.</p><p><strong>Arguments</strong></p><ul><li><code>text</code>: A string or a collection of strings to be analyzed for language identification.</li><li><code>languages::Vector{String}</code>: The list of languages to choose from. Omitting this argument will use all supported languages.</li><li><code>profiles::Vector{Dict{Vector{UInt8}, Float32}}</code>: The language profiles to use for identification. Omitting this argument will use the default profiles.</li><li><code>ngram::Union{Int, AbstractVector}</code>: The length of utf-8 byte n-grams to use for language detection. The default value is the value set in <a href="#LanguageIdentification.initialize-Tuple{}"><code>initialize</code></a>, and should not exceed that value.</li></ul><p><strong>Returns</strong></p><ul><li>The language of the given text.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/159467bef124b6a3146d79ba11aa7735d92f6278/src/detector.jl#L100-L112">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.langprob-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}" href="#LanguageIdentification.langprob-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}"><code>LanguageIdentification.langprob</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">langprob(text, languages::Vector{String}, profiles::Vector{Dict{Vector{UInt8}, Float32}}; topk=5, ngram=NGRAM)</code></pre><p>Returns the probability distribution of the language of the given text based on the provided language profiles.</p><p><strong>Arguments</strong></p><ul><li><code>text</code>: A string or a collection of strings to be analyzed for language identification.</li><li><code>languages::Vector{String}</code>: A list of languages to choose from. If this argument is not provided, all the languages returned by the <a href="#LanguageIdentification.supported_languages-Tuple{}"><code>supported_languages</code></a> function will be used.</li><li><code>profiles::Vector{Dict{Vector{UInt8}, Float32}}</code>: The language profiles to use for identification. If this argument is not provided, the default profiles will be used.</li><li><code>topk::Int</code>: The number of candidates to return. The default value is 5.</li><li><code>ngram::Union{Int, AbstractVector}</code>: The length of utf-8 byte n-grams to use for language detection. The default value is the value set in <a href="#LanguageIdentification.initialize-Tuple{}"><code>initialize</code></a>, and should not exceed that value.</li></ul><p><strong>Returns</strong></p><ul><li>A list of the <code>topk</code> languages and their probabilities.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/159467bef124b6a3146d79ba11aa7735d92f6278/src/detector.jl#L128-L142">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.supported_languages-Tuple{}" href="#LanguageIdentification.supported_languages-Tuple{}"><code>LanguageIdentification.supported_languages</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">supported_languages() -&gt; Vector{String}</code></pre><p>Return a vector containing all the languages (ISO 639-3 codes) that are supported by this package. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/159467bef124b6a3146d79ba11aa7735d92f6278/src/detector.jl#L10-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LanguageIdentification.vocabulary_sizes-Tuple{}" href="#LanguageIdentification.vocabulary_sizes-Tuple{}"><code>LanguageIdentification.vocabulary_sizes</code></a> — <span class="docstring-category">Method</span></header><section><div><p>The function <code>vocabulary_sizes()</code> returns the sizes of the vocabulary for each language that was loaded by the <a href="#LanguageIdentification.initialize-Tuple{}"><code>initialize</code></a> function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/guo-yong-zhi/LanguageIdentification.jl/blob/159467bef124b6a3146d79ba11aa7735d92f6278/src/detector.jl#L18-L20">source</a></section></article><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#LanguageIdentification.initialize-Tuple{}"><code>LanguageIdentification.initialize</code></a></li><li><a href="#LanguageIdentification.langid-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}"><code>LanguageIdentification.langid</code></a></li><li><a href="#LanguageIdentification.langprob-Tuple{Any, Vector{String}, Vector{Dict{Vector{UInt8}, Float32}}}"><code>LanguageIdentification.langprob</code></a></li><li><a href="#LanguageIdentification.supported_languages-Tuple{}"><code>LanguageIdentification.supported_languages</code></a></li><li><a href="#LanguageIdentification.vocabulary_sizes-Tuple{}"><code>LanguageIdentification.vocabulary_sizes</code></a></li></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 10 September 2023 09:55">Sunday 10 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>