class_docstr: Matrix Co-Factorization.
  
  Parameters
  ----------
  k: int, optional, default: 5
      The dimension of the latent factors.
  
  max_iter: int, optional, default: 100
      Maximum number of iterations or the number of epochs for SGD.
  
  learning_rate: float, optional, default: 0.001
      The learning rate for SGD_RMSProp.
  
  gamma: float, optional, default: 0.9
      The weight for previous/current gradient in RMSProp.
  
  lamda: float, optional, default: 0.001
      The regularization parameter.
  
  name: string, optional, default: 'MCF'
      The name of the recommender model.
  
  trainable: boolean, optional, default: True
      When False, the model is not trained and Cornac assumes that the model is already         pre-trained (U and V are not None).
  
  item-affinity network: See "cornac/examples/mcf_office.py" for an example of how to use         cornac's graph modality to load and provide the "item-affinity network" for MCF.
  
  verbose: boolean, optional, default: False
      When True, some running logs are displayed.
  
  init_params: dictionary, optional, default: None
      List of initial parameters, e.g., init_params = {'U': U, 'V': V, 'Z', Z}.
  
      U: ndarray, shape (n_users, k)
          User latent factors.
      
      V: ndarray, shape (n_items, k)
          Item latent factors.
      
      Z: ndarray, shape (n_items, k)
          The "Also-Viewed" item latent factors.
  
  seed: int, optional, default: None
      Random seed for parameters initialization.
  
  References
  ----------
  * Park, Chanyoung, Donghyun Kim, Jinoh Oh, and Hwanjo Yu. "Do Also-Viewed Products Help User Rating Prediction?."     In Proceedings of WWW, pp. 1113-1122. 2017.
class_docstr_tok: ["Matrix","Co-Factorization",".","Parameters","--","--","--","--","--","k",":","int",",","optional",",","default",":","5","The","dimension","of","the","latent","factors",".","max_iter",":","int",",","optional",",","default",":","100","Maximum","number","of","iterations","or","the","number","of","epochs","for","SGD",".","learning_rate",":","float",",","optional",",","default",":","0.001","The","learning","rate","for","SGD_RMSProp",".","gamma",":","float",",","optional",",","default",":","0.9","The","weight","for","previous\/current","gradient","in","RMSProp",".","lamda",":","float",",","optional",",","default",":","0.001","The","regularization","parameter",".","name",":","string",",","optional",",","default",":","'MCF'","The","name","of","the","recommender","model",".","trainable",":","boolean",",","optional",",","default",":","True","When","False",",","the","model","is","not","trained","and","Cornac","assumes","that","the","model","is","already","pre-trained","(","U","and","V","are","not","None",")",".","item-affinity","network",":","See","``","cornac\/examples\/mcf_office.py","''","for","an","example","of","how","to","use","cornac","'s","graph","modality","to","load","and","provide","the","``","item-affinity","network","''","for","MCF",".","verbose",":","boolean",",","optional",",","default",":","False","When","True",",","some","running","logs","are","displayed",".","init_params",":","dictionary",",","optional",",","default",":","None","List","of","initial","parameters",",","e.g.",",","init_params","=","{","'","U","'",":","U",",","'","V","'",":","V",",","'","Z","'",",","Z","}",".","U",":","ndarray",",","shape","(","n_users",",","k",")","User","latent","factors",".","V",":","ndarray",",","shape","(","n_items",",","k",")","Item","latent","factors",".","Z",":","ndarray",",","shape","(","n_items",",","k",")","The","``","Also-Viewed","''","item","latent","factors",".","seed",":","int",",","optional",",","default",":","None","Random","seed","for","parameters","initialization",".","References","--","--","--","--","--","*","Park",",","Chanyoung",",","Donghyun","Kim",",","Jinoh","Oh",",","and","Hwanjo","Yu",".","``","Do","Also-Viewed","Products","Help","User","Rating","Prediction","?",".","''","In","Proceedings","of","WWW",",","pp",".","1113-1122",".","2017","."]
docstr: Fit the model to observations.
  
  Parameters
  ----------
  train_set: :obj:`cornac.data.Dataset`, required
      User-Item preference data as well as additional modalities.
  
  val_set: :obj:`cornac.data.Dataset`, optional, default: None
      User-Item preference data for model selection purposes (e.g., early stopping).
  
  Returns
  -------
  self : object
docstr_tok: ["Fit","the","model","to","observations",".","Parameters","--","--","--","--","--","train_set",":",":","obj",":","`","cornac.data.Dataset","`",",","required","User-Item","preference","data","as","well","as","additional","modalities",".","val_set",":",":","obj",":","`","cornac.data.Dataset","`",",","optional",",","default",":","None","User-Item","preference","data","for","model","selection","purposes","(","e.g.",",","early","stopping",")",".","Returns","--","--","--","-","self",":","object"]
code: def fit(self, train_set, val_set=None):
      """Fit the model to observations.
  
      Parameters
      ----------
      train_set: :obj:`cornac.data.Dataset`, required
          User-Item preference data as well as additional modalities.
  
      val_set: :obj:`cornac.data.Dataset`, optional, default: None
          User-Item preference data for model selection purposes (e.g., early stopping).
  
      Returns
      -------
      self : object
      """
      Recommender.fit(self, train_set, val_set)
  
      if self.trainable:
          # user-item interactions
          (rat_uid, rat_iid, rat_val) = train_set.uir_tuple
  
          # item-item affinity network
          train_item_indices = set(train_set.uir_tuple[1])
          (
              net_iid,
              net_jid,
              net_val,
          ) = train_set.item_graph.get_train_triplet(
              train_item_indices, train_item_indices
          )
          if [self.min_rating, self.max_rating] != [0, 1]:
              if self.min_rating == self.max_rating:
                  rat_val = scale(
                      rat_val, 0.0, 1.0, 0.0, self.max_rating
                  )
              else:
                  rat_val = scale(
                      rat_val,
                      0.0,
                      1.0,
                      self.min_rating,
                      self.max_rating,
                  )
  
          if [min(net_val), max(net_val)] != [0, 1]:
              if min(net_val) == max(net_val):
                  net_val = scale(net_val, 0.0, 1.0, 0.0, max(net_val))
              else:
                  net_val = scale(
                      net_val, 0.0, 1.0, min(net_val), max(net_val)
                  )
  
          rat_val = np.array(rat_val, dtype="float32")
          rat_uid = np.array(rat_uid, dtype="int32")
          rat_iid = np.array(rat_iid, dtype="int32")
  
          net_val = np.array(net_val, dtype="float32")
          net_iid = np.array(net_iid, dtype="int32")
          net_jid = np.array(net_jid, dtype="int32")
  
          if self.verbose:
              print("Learning...")
  
          from cornac.models.mcf import mcf
  
          res = mcf.mcf(
              rat_uid,
              rat_iid,
              rat_val,
              net_iid,
              net_jid,
              net_val,
              k=self.k,
              n_users=train_set.num_users,
              n_items=train_set.num_items,
              n_ratings=len(rat_val),
              n_edges=len(net_val),
              n_epochs=self.max_iter,
              lamda=self.lamda,
              learning_rate=self.learning_rate,
              gamma=self.gamma,
              init_params={"U": self.U, "V": self.V, "Z": self.Z},
              verbose=self.verbose,
              seed=self.seed,
          )
  
          self.U = np.asarray(res["U"])
          self.V = np.asarray(res["V"])
          self.Z = np.asarray(res["Z"])
  
          if self.verbose:
              print("Learning completed")
      elif self.verbose:
          print("%s is trained already (trainable = False)" % self.name)
  
      return self
  
file_path: cornac/cornac/models/mcf/recom_mcf.py
imports: import numpy
  from ..recommender import Recommender
  from ..recommender import ANNMixin, MEASURE_DOT
  from ...utils.common import sigmoid
  from ...utils.common import scale
  from ...exception import ScoreException
label_desc: Use image node_id 2 for calling the MCF obj's underlying member method code with example usage: obj.fit(train_set, val_set) and returns: self