8. cltk package¶
Init module for importing the CLTK class.
8.1. Subpackages¶
- 8.1.1. cltk.alphabet package
- 8.1.1.1. Subpackages
- 8.1.1.2. Submodules
- 8.1.1.3. cltk.alphabet.ang module
- 8.1.1.4. cltk.alphabet.arb module
- 8.1.1.5. cltk.alphabet.arc module
- 8.1.1.6. cltk.alphabet.ben module
- 8.1.1.7. cltk.alphabet.egy module
- 8.1.1.8. cltk.alphabet.enm module
- 8.1.1.9. cltk.alphabet.fro module
- 8.1.1.10. cltk.alphabet.gmh module
- 8.1.1.11. cltk.alphabet.guj module
- 8.1.1.12. cltk.alphabet.hin module
- 8.1.1.13. cltk.alphabet.kan module
- 8.1.1.14. cltk.alphabet.lat module
- 8.1.1.15. cltk.alphabet.non module
- 8.1.1.16. cltk.alphabet.omr module
- 8.1.1.17. cltk.alphabet.ory module
- 8.1.1.18. cltk.alphabet.ota module
- 8.1.1.19. cltk.alphabet.oty module
- 8.1.1.20. cltk.alphabet.pes module
- 8.1.1.21. cltk.alphabet.pli module
- 8.1.1.22. cltk.alphabet.processes module
- 8.1.1.23. cltk.alphabet.san module
- 8.1.1.24. cltk.alphabet.tel module
- 8.1.1.25. cltk.alphabet.text_normalization module
- 8.1.1.26. cltk.alphabet.urd module
- 8.1.2. cltk.core package
- 8.1.3. cltk.data package
- 8.1.4. cltk.dependency package
- 8.1.5. cltk.embeddings package
- 8.1.6. cltk.languages package
- 8.1.7. cltk.lemmatize package
- 8.1.8. cltk.lexicon package
- 8.1.9. cltk.morphology package
- 8.1.10. cltk.ner package
- 8.1.11. cltk.phonology package
- 8.1.11.1. Subpackages
- 8.1.11.1.1. cltk.phonology.ang package
- 8.1.11.1.2. cltk.phonology.arb package
- 8.1.11.1.3. cltk.phonology.enm package
- 8.1.11.1.4. cltk.phonology.gmh package
- 8.1.11.1.5. cltk.phonology.got package
- 8.1.11.1.6. cltk.phonology.grc package
- 8.1.11.1.7. cltk.phonology.lat package
- 8.1.11.1.8. cltk.phonology.non package
- 8.1.11.1.8.1. Subpackages
- 8.1.11.1.8.2. Submodules
- 8.1.11.1.8.3. cltk.phonology.non.orthophonology module
- 8.1.11.1.8.4. cltk.phonology.non.phonology module
- 8.1.11.1.8.5. cltk.phonology.non.syllabifier module
- 8.1.11.1.8.6. cltk.phonology.non.transcription module
- 8.1.11.1.8.7. cltk.phonology.non.utils module
- 8.1.11.2. Submodules
- 8.1.11.3. cltk.phonology.akk module
- 8.1.11.4. cltk.phonology.orthophonology module
- 8.1.11.5. cltk.phonology.processes module
- 8.1.11.6. cltk.phonology.syllabifier_processes module
- 8.1.11.7. cltk.phonology.syllabify module
- 8.1.11.8. cltk.phonology.transcription_processes module
- 8.1.11.1. Subpackages
- 8.1.12. cltk.prosody package
- 8.1.12.1. Subpackages
- 8.1.12.1.1. cltk.prosody.lat package
- 8.1.12.1.1.1. Submodules
- 8.1.12.1.1.2. cltk.prosody.lat.clausulae_analysis module
- 8.1.12.1.1.3. cltk.prosody.lat.hendecasyllable_scanner module
- 8.1.12.1.1.4. cltk.prosody.lat.hexameter_scanner module
- 8.1.12.1.1.5. cltk.prosody.lat.macronizer module
- 8.1.12.1.1.6. cltk.prosody.lat.metrical_validator module
- 8.1.12.1.1.7. cltk.prosody.lat.pentameter_scanner module
- 8.1.12.1.1.8. cltk.prosody.lat.scanner module
- 8.1.12.1.1.9. cltk.prosody.lat.scansion_constants module
- 8.1.12.1.1.10. cltk.prosody.lat.scansion_formatter module
- 8.1.12.1.1.11. cltk.prosody.lat.string_utils module
- 8.1.12.1.1.12. cltk.prosody.lat.syllabifier module
- 8.1.12.1.1.13. cltk.prosody.lat.verse module
- 8.1.12.1.1.14. cltk.prosody.lat.verse_scanner module
- 8.1.12.1.1. cltk.prosody.lat package
- 8.1.12.2. Submodules
- 8.1.12.3. cltk.prosody.gmh module
- 8.1.12.4. cltk.prosody.grc module
- 8.1.12.5. cltk.prosody.non module
- 8.1.12.1. Subpackages
- 8.1.13. cltk.readers package
- 8.1.14. cltk.sentence package
- 8.1.15. cltk.stem package
- 8.1.16. cltk.stops package
- 8.1.16.1. Submodules
- 8.1.16.2. cltk.stops.akk module
- 8.1.16.3. cltk.stops.ang module
- 8.1.16.4. cltk.stops.arb module
- 8.1.16.5. cltk.stops.cop module
- 8.1.16.6. cltk.stops.enm module
- 8.1.16.7. cltk.stops.fro module
- 8.1.16.8. cltk.stops.gmh module
- 8.1.16.9. cltk.stops.grc module
- 8.1.16.10. cltk.stops.hin module
- 8.1.16.11. cltk.stops.lat module
- 8.1.16.12. cltk.stops.non module
- 8.1.16.13. cltk.stops.omr module
- 8.1.16.14. cltk.stops.pan module
- 8.1.16.15. cltk.stops.processes module
- 8.1.16.16. cltk.stops.san module
- 8.1.16.17. cltk.stops.words module
- 8.1.17. cltk.tag package
- 8.1.18. cltk.text package
- 8.1.19. cltk.tokenizers package
- 8.1.19.1. Subpackages
- 8.1.19.2. Submodules
- 8.1.19.3. cltk.tokenizers.akk module
- 8.1.19.4. cltk.tokenizers.arb module
- 8.1.19.5. cltk.tokenizers.enm module
- 8.1.19.6. cltk.tokenizers.fro module
- 8.1.19.7. cltk.tokenizers.gmh module
- 8.1.19.8. cltk.tokenizers.line module
- 8.1.19.9. cltk.tokenizers.non module
- 8.1.19.10. cltk.tokenizers.processes module
- 8.1.19.11. cltk.tokenizers.utils module
- 8.1.19.12. cltk.tokenizers.word module
- 8.1.20. cltk.utils package
- 8.1.21. cltk.wordnet package
8.2. Submodules¶
8.3. cltk.nlp module¶
Primary module for CLTK pipeline.
-
class
cltk.nlp.
NLP
(language, custom_pipeline=None)[source]¶ Bases:
object
NLP class for default processing.
-
process_objects
= {}¶
-
process_lock
= <unlocked _thread.lock object>¶
-
_print_pipelines_for_current_lang
()[source]¶ Print to screen the
Process``es invoked upon invocation of ``NLP()
.
-
_get_process_object
(process_object)[source]¶ Returns an instance of a process from a memoized hash. An un-instantiated process is created and stashed in the cache.
- Return type
-
analyze
(text)[source]¶ The primary method for the NLP object, to which raw text strings are passed.
- Parameters
text (
str
) – Input text string.- Return type
- Returns
CLTK
Doc
containing all processed information.
>>> from cltk.languages.example_texts import get_example_text >>> from cltk.core.data_types import Doc >>> cltk_nlp = NLP(language="lat") >>> cltk_doc = cltk_nlp.analyze(text=get_example_text("lat")) >>> isinstance(cltk_doc, Doc) True >>> cltk_doc.words[0] Word(index_char_start=None, index_char_stop=None, index_token=0, index_sentence=0, string='Gallia', pos=noun, lemma='mallis', stem=None, scansion=None, xpos='A1|grn1|casA|gen2', upos='NOUN', dependency_relation='nsubj', governor=3, features={Case: [nominative], Degree: [positive], Gender: [feminine], Number: [singular]}, category={F: [neg], N: [pos], V: [neg]}, embedding=..., stop=False, named_entity='LOCATION', syllables=None, phonetic_transcription=None)
-
_get_pipeline
()[source]¶ Select appropriate pipeline for given language. If custom processing is requested, ensure that user-selected choices are valid, both in themselves and in unison.
>>> from cltk.core.data_types import Pipeline >>> cltk_nlp = NLP(language="lat") >>> lat_pipeline = cltk_nlp._get_pipeline() >>> isinstance(cltk_nlp.pipeline, Pipeline) True >>> isinstance(lat_pipeline, Pipeline) True >>> cltk_nlp = NLP(language="axm") Traceback (most recent call last): ... cltk.core.exceptions.UnimplementedAlgorithmError: Valid ISO language code, however this algorithm is not available for ``axm``.
- Return type
-