org.ranksys.formats.factorization

Class SimpleFMFormat

java.lang.Object

org.ranksys.formats.factorization.SimpleFMFormat

All Implemented Interfaces:

FMFormat

public class SimpleFMFormat
extends Object
implements FMFormat

Factorisation machine format in zip-compressed, human readable files .

Author:

Saúl Vargas (Saul@VargasSandoval.es)

Method Summary

Modifier and Type	Method and Description
static SimpleFMFormat	get() Returns an instance of this class.
<U,I> PreferenceFM<U,I>	load(InputStream in, FastUserIndex<U> users, FastItemIndex<I> items) Loads a factorisation machine from an input stream.
<U,I> void	save(PreferenceFM fm, OutputStream out) Saves a factorisation machine in an output stream.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static SimpleFMFormat get()

Returns an instance of this class.

Returns:

an instance of SimpleFMFormat

save

public <U,I> void save(PreferenceFM fm,
                       OutputStream out)
                throws IOException

Description copied from interface: FMFormat

Saves a factorisation machine in an output stream.

Specified by:

save in interface FMFormat

Type Parameters:

U - user type

I - item type

Parameters:

fm - factorisation machine for recommendation tasks

out - output stream where the factorisation machine is written

Throws:

IOException - when I/O problems

load

public <U,I> PreferenceFM<U,I> load(InputStream in,
                                    FastUserIndex<U> users,
                                    FastItemIndex<I> items)
                             throws IOException

Description copied from interface: FMFormat

Loads a factorisation machine from an input stream.

Specified by:

load in interface FMFormat

Type Parameters:

U - type of users

I - type of items

Parameters:

in - input stream

users - user index

items - item index

Returns:

factorisation machine for recommendation tasks

Throws:

IOException - when I/O problems