pyvalues.classifier

class pyvalues.classifier.OriginalValuesClassifier

Bases: ABC

Classifier for the ten values from Schwartz original system.

classify_document_for_original_values(document: Document) → ValuesAnnotatedDocument[OriginalValues]

Classifies each segment.

Parameters:

document (Document) – The document to classify

Returns:

A copy of the document with the classified values

Return type:

ValuesAnnotatedDocument[OriginalValues]

classify_documents_for_original_values(documents: Iterable[Document]) → Generator[ValuesAnnotatedDocument[OriginalValues], None, None]

Classifies each document.

Parameters:

documents (Iterable[Document]) – The documents to classify

Returns:

A copy of each document with the classified values

Return type:

Generator[ValuesAnnotatedDocument[OriginalValues], None, None]

classify_for_original_values(segment: str, language: LanguageAlpha2 | str = 'en') → OriginalValues

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

OriginalValues

abstractmethod classify_segments_for_original_values(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[OriginalValues, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classifications for each segment

Return type:

Generator[OriginalValues, None, None]

class pyvalues.classifier.OriginalValuesWithAttainmentClassifier

Bases: OriginalValuesClassifier

Classifier for the ten values from Schwartz original system with attainment.

classify_document_for_original_values_with_attainment(document: Document) → ValuesAnnotatedDocument[OriginalValuesWithAttainment]

Classifies each segment.

Parameters:

document (Document) – The document to classify

Returns:

A copy of the document with the classified values

Return type:

ValuesAnnotatedDocument[OriginalValuesWithAttainment]

classify_documents_for_original_values_with_attainment(documents: Iterable[Document]) → Generator[ValuesAnnotatedDocument[OriginalValuesWithAttainment], None, None]

Classifies each document.

Parameters:

documents (Iterable[Document]) – The documents to classify

Returns:

A copy of each document with the classified values

Return type:

Generator[ValuesAnnotatedDocument[OriginalValuesWithAttainment], None, None]

classify_for_original_values(segment: str, language: LanguageAlpha2 | str = 'en') → OriginalValues

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

OriginalValues

classify_for_original_values_with_attainment(segment: str, language: LanguageAlpha2 | str = 'en') → OriginalValuesWithAttainment

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

OriginalValuesWithAttainment

classify_segments_for_original_values(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[OriginalValues, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classifications for each segment

Return type:

Generator[OriginalValues, None, None]

abstractmethod classify_segments_for_original_values_with_attainment(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[OriginalValuesWithAttainment, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classification for each segment

Return type:

Generator[OriginalValuesWithAttainment, None, None]

class pyvalues.classifier.RefinedCoarseValuesClassifier

Bases: OriginalValuesClassifier

Classifier for the the twelve values from Schwartz refined system (19 values) when combining values with same name prefix.

classify_document_for_refined_coarse_values(document: Document) → ValuesAnnotatedDocument[RefinedCoarseValues]

Classifies each segment.

Parameters:

document (Document) – The document to classify

Returns:

A copy of the document with the classified values

Return type:

ValuesAnnotatedDocument[RefinedCoarseValues]

classify_documents_for_refined_coarse_values(documents: Iterable[Document]) → Generator[ValuesAnnotatedDocument[RefinedCoarseValues], None, None]

Classifies each document.

Parameters:

documents (Iterable[Document]) – The documents to classify

Returns:

A copy of each document with the classified values

Return type:

Generator[ValuesAnnotatedDocument[RefinedCoarseValues], None, None]

classify_for_original_values(segment: str, language: LanguageAlpha2 | str = 'en') → OriginalValues

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

OriginalValues

classify_for_refined_coarse_values(segment: str, language: LanguageAlpha2 | str = 'en') → RefinedCoarseValues

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

RefinedCoarseValues

classify_segments_for_original_values(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[OriginalValues, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classifications for each segment

Return type:

Generator[OriginalValues, None, None]

abstractmethod classify_segments_for_refined_coarse_values(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[RefinedCoarseValues, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classification for each segment

Return type:

Generator[RefinedCoarseValues, None, None]

class pyvalues.classifier.RefinedCoarseValuesWithAttainmentClassifier

Bases: OriginalValuesWithAttainmentClassifier, RefinedCoarseValuesClassifier

Classifier for the the twelve values from Schwartz refined system (19 values) when combining values with same name prefix and with attainment.

classify_document_for_refined_coarse_values_with_attainment(document: Document) → ValuesAnnotatedDocument[RefinedCoarseValuesWithAttainment]

Classifies each segment.

Parameters:

document (Document) – The document to classify

Returns:

A copy of the document with the classified values

Return type:

ValuesAnnotatedDocument[RefinedCoarseValuesWithAttainment]

classify_documents_for_refined_coarse_values_with_attainment(documents: Iterable[Document]) → Generator[ValuesAnnotatedDocument[RefinedCoarseValuesWithAttainment], None, None]

Classifies each document.

Parameters:

documents (Iterable[Document]) – The documents to classify

Returns:

A copy of each document with the classified values

Return type:

Generator[ValuesAnnotatedDocument[RefinedCoarseValuesWithAttainment], None, None]

classify_for_original_values_with_attainment(segment: str, language: LanguageAlpha2 | str = 'en') → OriginalValuesWithAttainment

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

OriginalValuesWithAttainment

classify_for_refined_coarse_values(segment: str, language: LanguageAlpha2 | str = 'en') → RefinedCoarseValues

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

RefinedCoarseValues

classify_for_refined_coarse_values_with_attainment(segment: str, language: LanguageAlpha2 | str = 'en') → RefinedCoarseValuesWithAttainment

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

RefinedCoarseValuesWithAttainment

classify_segments_for_original_values_with_attainment(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[OriginalValuesWithAttainment, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classification for each segment

Return type:

Generator[OriginalValuesWithAttainment, None, None]

classify_segments_for_refined_coarse_values(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[RefinedCoarseValues, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classification for each segment

Return type:

Generator[RefinedCoarseValues, None, None]

abstractmethod classify_segments_for_refined_coarse_values_with_attainment(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[RefinedCoarseValuesWithAttainment, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classifications for each segment

Return type:

Generator[RefinedCoarseValuesWithAttainment, None, None]

class pyvalues.classifier.RefinedValuesClassifier

Bases: RefinedCoarseValuesClassifier

Classifier for the 19 values from Schwartz refined system.

classify_document_for_refined_values(document: Document) → ValuesAnnotatedDocument[RefinedValues]

Classifies each segment.

Parameters:

document (Document) – The document to classify

Returns:

A copy of the document with the classified values

Return type:

ValuesAnnotatedDocument[RefinedValues]

classify_documents_for_refined_values(documents: Iterable[Document]) → Generator[ValuesAnnotatedDocument[RefinedValues], None, None]

Classifies each document.

Parameters:

documents (Iterable[Document]) – The documents to classify

Returns:

A copy of each document with the classified values

Return type:

Generator[ValuesAnnotatedDocument[RefinedValues], None, None]

classify_for_refined_coarse_values(segment: str, language: LanguageAlpha2 | str = 'en') → RefinedCoarseValues

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

RefinedCoarseValues

classify_for_refined_values(segment: str, language: LanguageAlpha2 | str = 'en') → RefinedValues

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

RefinedValues

classify_segments_for_refined_coarse_values(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[RefinedCoarseValues, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classification for each segment

Return type:

Generator[RefinedCoarseValues, None, None]

abstractmethod classify_segments_for_refined_values(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[RefinedValues, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classifications for each segment

Return type:

Generator[RefinedValues, None, None]

class pyvalues.classifier.RefinedValuesWithAttainmentClassifier

Bases: RefinedCoarseValuesWithAttainmentClassifier, RefinedValuesClassifier

Classifier for the 19 values from Schwartz refined system with attainment.

classify_document_for_refined_values_with_attainment(document: Document) → ValuesAnnotatedDocument[RefinedValuesWithAttainment]

Classifies each segment.

Parameters:

document (Document) – The document to classify

Returns:

A copy of the document with the classified values

Return type:

ValuesAnnotatedDocument[RefinedValuesWithAttainment]

classify_documents_for_refined_values_with_attainment(documents: Iterable[Document]) → Generator[ValuesAnnotatedDocument[RefinedValuesWithAttainment], None, None]

Classifies each document.

Parameters:

documents (Iterable[Document]) – The documents to classify

Returns:

A copy of each document with the classified values

Return type:

Generator[ValuesAnnotatedDocument[RefinedValuesWithAttainment], None, None]

classify_for_refined_coarse_values_with_attainment(segment: str, language: LanguageAlpha2 | str = 'en') → RefinedCoarseValuesWithAttainment

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

RefinedCoarseValuesWithAttainment

classify_for_refined_values(segment: str, language: LanguageAlpha2 | str = 'en') → RefinedValues

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

RefinedValues

classify_for_refined_values_with_attainment(segment: str, language: LanguageAlpha2 | str = 'en') → RefinedValuesWithAttainment

Classifies the segment.

Parameters:

  • segment (str) – The segment to classify

  • language (LanguageAlpha2 | str) – The language of the segment

Returns:

The classification

Return type:

RefinedValuesWithAttainment

classify_segments_for_refined_coarse_values_with_attainment(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[RefinedCoarseValuesWithAttainment, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classifications for each segment

Return type:

Generator[RefinedCoarseValuesWithAttainment, None, None]

classify_segments_for_refined_values(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[RefinedValues, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classifications for each segment

Return type:

Generator[RefinedValues, None, None]

abstractmethod classify_segments_for_refined_values_with_attainment(segments: Iterable[str], language: LanguageAlpha2 | str = 'en') → Generator[RefinedValuesWithAttainment, None, None]

Classifies each segment.

Parameters:

  • segments (Iterable[str]) – The segments to classify

  • language (LanguageAlpha2 | str) – The language of the segments

Returns:

Classifications for each segment

Return type:

Generator[RefinedValuesWithAttainment, None, None]