Package eu.h2020.helios_social.modules.socialgraphmining

Class SocialGraphMiner

java.lang.Object

eu.h2020.helios_social.modules.socialgraphmining.SocialGraphMiner

Direct Known Subclasses:

CentralizedGNNMiner, DifferenceMiner, GNNMiner, MemoryMiner, PPRMiner, ProbabilityMiner, RandomMiner, RepeatAndReplyMiner, SocialGraphMinerCombination, TFMiner

public abstract class SocialGraphMiner
extends java.lang.Object

Provides an abstraction of the basic capabilities and requirements of graph mining algorithms.

Author:

Emmanouil Krasanakis

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SocialGraphMiner.InteractionType
static class	SocialGraphMiner.SocialGraphMinerParameters

Method Summary

Modifier and Type	Method	Description
eu.h2020.helios_social.core.contextualegonetwork.ContextualEgoNetwork	getContextualEgoNetwork()
SocialGraphMiner.SocialGraphMinerParameters	getModelParameterObject(eu.h2020.helios_social.core.contextualegonetwork.Interaction interaction)	Retrieves the parameters of the mining model that will be sent alongside the created interaction.
java.lang.String	getModelParameters(eu.h2020.helios_social.core.contextualegonetwork.Interaction interaction)	Retrieves the parameters of the mining model that will be sent alongside the created interaction.
void	newInteraction(eu.h2020.helios_social.core.contextualegonetwork.Interaction interaction, java.lang.String neighborModelParameters, SocialGraphMiner.InteractionType interactionType)	Makes the graph miner aware that a user received an interaction from another user with getModelParameters(eu.h2020.helios_social.core.contextualegonetwork.Interaction).
abstract void	newInteractionParameters(eu.h2020.helios_social.core.contextualegonetwork.Interaction interaction, SocialGraphMiner.SocialGraphMinerParameters neighborModelParameters, SocialGraphMiner.InteractionType interactionType)
abstract double	predictNewInteraction(eu.h2020.helios_social.core.contextualegonetwork.Context context, eu.h2020.helios_social.core.contextualegonetwork.Node destinationNode)	Predicts the weight of performing a SEND interaction between the given context's ego and a destination node within a given context.
java.util.HashMap<eu.h2020.helios_social.core.contextualegonetwork.Node,java.lang.Double>	recommendInteractions(eu.h2020.helios_social.core.contextualegonetwork.Context context)	Calls predictNewInteraction(Context, Node) to score the likelihood of interacting with all nodes of the given context.
SocialGraphMiner	setSendPermision(boolean sendPermision)	Sets whether the miner is permitted to send parameters when asked to, thus helping write seamless code, especially when multiple miner parameters are simultaneously send by SocialGraphMinerCombination instances.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getContextualEgoNetwork

public eu.h2020.helios_social.core.contextualegonetwork.ContextualEgoNetwork getContextualEgoNetwork()

newInteractionParameters

public abstract void newInteractionParameters(eu.h2020.helios_social.core.contextualegonetwork.Interaction interaction,
                                              SocialGraphMiner.SocialGraphMinerParameters neighborModelParameters,
                                              SocialGraphMiner.InteractionType interactionType)

newInteraction

public final void newInteraction(eu.h2020.helios_social.core.contextualegonetwork.Interaction interaction,
                                 java.lang.String neighborModelParameters,
                                 SocialGraphMiner.InteractionType interactionType)

Makes the graph miner aware that a user received an interaction from another user with getModelParameters(eu.h2020.helios_social.core.contextualegonetwork.Interaction).

Parameters:

interaction - A new interaction the user initiates expressed in terms of the contextual ego network

neighborModelParameters - The neighbor parameters. May be null for when interactionType==SEND.

interactionType - The type of the interaction (SEND, RECEIVE or RECEIVE_REPLY corresponds to acknowledging the receive).

setSendPermision

public SocialGraphMiner setSendPermision(boolean sendPermision)

Sets whether the miner is permitted to send parameters when asked to, thus helping write seamless code, especially when multiple miner parameters are simultaneously send by SocialGraphMinerCombination instances. Setting send permissions to true makes miners work as intended, but setting them to false would force them to not send parameters that would improve recommendations for others.

Parameters:

sendPermision - Whether to allow the miner to send parameters.

Returns:

this miner

getModelParameterObject

public final SocialGraphMiner.SocialGraphMinerParameters getModelParameterObject(eu.h2020.helios_social.core.contextualegonetwork.Interaction interaction)

Retrieves the parameters of the mining model that will be sent alongside the created interaction. Prefer use of getModelParameters(Interaction) to guarantee correct serialization, though the two methods can used interchangeably. This functionality can be reduced to sending a null by setSendPermision(boolean)

Parameters:

interaction - The new interaction the user receives expressed in terms of the contextual ego network

Returns:

A SocialGraphMiner.SocialGraphMinerParameters object of miner parameters.

getModelParameters

public final java.lang.String getModelParameters(eu.h2020.helios_social.core.contextualegonetwork.Interaction interaction)

Retrieves the parameters of the mining model that will be sent alongside the created interaction. This uses the contextual ego network's serializer to convert the outcome of getModelParameterObject(Interaction) to a string representation. The two methods can used interchangeably. This functionality can be reduced to sending a serialized null by setSendPermision(boolean)

Parameters:

interaction - The new interaction the user receives expressed in terms of the contextual ego network

Returns:

A String serialization of model parameters.

predictNewInteraction

public abstract double predictNewInteraction(eu.h2020.helios_social.core.contextualegonetwork.Context context,
                                             eu.h2020.helios_social.core.contextualegonetwork.Node destinationNode)

Predicts the weight of performing a SEND interaction between the given context's ego and a destination node within a given context. This method should typically return values in the [0,1] range, where higher values correspond to more likely interactions.

Parameters:

context - The context in which to perform the prediction.

destinationNode - The destination node of the interaction.

Returns:

The weight of performing the interaction (higher values are more likely).

recommendInteractions

public java.util.HashMap<eu.h2020.helios_social.core.contextualegonetwork.Node,java.lang.Double> recommendInteractions(eu.h2020.helios_social.core.contextualegonetwork.Context context)

Calls predictNewInteraction(Context, Node) to score the likelihood of interacting with all nodes of the given context.

Parameters:

context - The context for which to recommend interactions.

Returns:

A hash map of node scores (larger is more likely to occur.