Skip to content

Settings

NerModels

Bases: BaseSettings

Easily overwrite specific language model for specific languages via:

FTM_ANALYZE_NER_MODELS_DEU=de_core_news_lg

Source code in ftm_analyze/settings.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class NerModels(BaseSettings):
    """
    Easily overwrite specific language model for specific languages via:

    `FTM_ANALYZE_NER_MODELS_DEU=de_core_news_lg`
    """

    eng: str = "en_core_web_sm"
    deu: str = "de_core_news_sm"
    fra: str = "fr_core_news_sm"
    spa: str = "es_core_news_sm"
    rus: str = "ru_core_news_sm"
    por: str = "pt_core_news_sm"
    ron: str = "ro_core_news_sm"
    mkd: str = "mk_core_news_sm"
    ell: str = "el_core_news_sm"
    pol: str = "pl_core_news_sm"
    ita: str = "it_core_news_sm"
    lit: str = "lt_core_news_sm"
    nld: str = "nl_core_news_sm"
    nob: str = "nb_core_news_sm"
    nor: str = "nb_core_news_sm"
    dan: str = "da_core_news_sm"

Settings

Bases: BaseSettings

ftm-analyze settings management using pydantic-settings

Note

All settings can be set via environment variables or .env file, prepending FTM_ANALYZE_ (except for those with another alias)

Source code in ftm_analyze/settings.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
class Settings(BaseSettings):
    """
    `ftm-analyze` settings management using
    [pydantic-settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/)

    Note:
        All settings can be set via environment variables or `.env` file,
        prepending `FTM_ANALYZE_` (except for those with another alias)
    """

    model_config = SettingsConfigDict(
        env_prefix="ftm_analyze_",
        env_nested_delimiter="_",
        env_file=".env",
        extra="ignore",
    )

    ner_type_model_path: Path = Path("./models/model_type_prediction.ftz")
    """Local path to ftm type predict model"""

    ner_type_model_confidence: float = 0.85
    """Minimum confidence for ftm type predict model"""

    lid_model_path: Path = Path("./models/lid.176.ftz")
    """Local path to lid model"""

    ner_models: NerModels = NerModels()
    """Spacy models"""

    resolve_mentions: bool = True
    """Resolve known mentions via `juditha`"""

    annotate: bool = True
    """Insert annotations into `indexText` for resolved mentions"""

annotate = True class-attribute instance-attribute

Insert annotations into indexText for resolved mentions

lid_model_path = Path('./models/lid.176.ftz') class-attribute instance-attribute

Local path to lid model

ner_models = NerModels() class-attribute instance-attribute

Spacy models

ner_type_model_confidence = 0.85 class-attribute instance-attribute

Minimum confidence for ftm type predict model

ner_type_model_path = Path('./models/model_type_prediction.ftz') class-attribute instance-attribute

Local path to ftm type predict model

resolve_mentions = True class-attribute instance-attribute

Resolve known mentions via juditha