gransk.plugins.analysis

Compute useful things from stuff.

gransk.plugins.analysis.abstract_related

class gransk.plugins.analysis.abstract_related.Subscriber(pipeline)

Bases: gransk.core.abstract_subscriber.Subscriber

Find entities and documents that are related to each other based on found entities.

Add subscriber to pipeline.

Parameters:pipeline (gransk.core.pipeline.Pipeline) – Pipeline managing subscribers and events.

consume(doc, payload)

Abstract method that when implemented should add data from documents.

Parameters:

• doc (gransk.core.document.Document) – Document object.
• payload (file) – File pointer beloning to document.

get_related_to(_id, min_score=None, min_shared=None, max_results=None)

Get objects related to the given ID, based on:

• How many entities they have in common (related documents)
• How many documents they have in common (related entities)

Parameters:

• _id (str) – ID of the object (entity or document) to get related for.
• min_score (float) – shared / min(a_frequency, b_frequency).
• min_shared (int) – Minimum amount of shared documetns or entities.
• max_results (int) – Maximum number of related objects to return.

load_all(config)

Load all existing data.

Parameters:config (dict) – Configuration object.

setup(config)

Load existing data for given worker.

Parameters:config (dict) – Configuration object.

stop()

Write data to file.

gransk.plugins.analysis.entity_network

class gransk.plugins.analysis.entity_network.Subscriber(pipeline)

Bases: gransk.core.abstract_subscriber.Subscriber

Class computing network surrounding an entity.

Add subscriber to pipeline.

Parameters:pipeline (gransk.core.pipeline.Pipeline) – Pipeline managing subscribers and events.

consume(doc, payload)

Ignored.

get_for(entity_id, hops=1)

Get network around the given entity ID.

Parameters:

• entity_id (str) – Entity to get network for.
• hops (int) – Maximum distance of included nodes from the given entity.

Returns:

dict

setup(config)

Loads services for related entities and documents.

Parameters:config (dict) – Configuration object.

gransk.plugins.analysis.related_documents

class gransk.plugins.analysis.related_documents.Subscriber(pipeline)

Bases: gransk.plugins.analysis.abstract_related.Subscriber

Class for finding related documents based on the entities they have in common.

Add subscriber to pipeline.

Parameters:pipeline (gransk.core.pipeline.Pipeline) – Pipeline managing subscribers and events.

consume(doc, _)

Add all entities to the reference set.

Parameters:doc (gransk.core.document.Document) – Document object.

gransk.plugins.analysis.related_entities

class gransk.plugins.analysis.related_entities.Subscriber(pipeline)

Bases: gransk.plugins.analysis.abstract_related.Subscriber

Class for finding related entities based on the documents they have in common.

Add subscriber to pipeline.

Parameters:pipeline (gransk.core.pipeline.Pipeline) – Pipeline managing subscribers and events.

consume(doc, _)

Add document to each entity’s reference set.

Parameters:doc (gransk.core.document.Document) – Document object.