LocationChoiceModel -> MNLLocationChoiceModel.

UDST · Apr 29, 2014 · f8d60fe · f8d60fe
1 parent e60c2c0
commit f8d60fe
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/urbansim/models/__init__.py b/urbansim/models/__init__.py
@@ -1,2 +1,2 @@
 from .regression import RegressionModel, RegressionModelGroup
-from .lcm import LocationChoiceModel
+from .lcm import MNLLocationChoiceModel
diff --git a/urbansim/models/lcm.py b/urbansim/models/lcm.py
@@ -66,10 +66,11 @@ def unit_choice(chooser_ids, alternative_ids, probabilities):
     return choices
 
 
-class LocationChoiceModel(object):
+class MNLLocationChoiceModel(object):
     """
     A location choice model with the ability to store an estimated
     model and predict new data based on the model.
+    Based on multinomial logit.
 
     Parameters
     ----------
@@ -94,7 +95,7 @@ def __init__(self, alts_fit_filters, alts_predict_filters,
         # LCMs never have a constant
         self.model_expression = model_expression + ' - 1'
         self.sample_size = sample_size
-        self.name = name or 'LocationChoiceModel'
+        self.name = name or 'MNLLocationChoiceModel'
 
         self._log_lks = None
         self._model_columns = None

diff --git a/urbansim/models/tests/test_lcm.py b/urbansim/models/tests/test_lcm.py
@@ -53,8 +53,8 @@ def test_unit_choice_none_available(choosers, alternatives):
     assert choices.isnull().all()
 
 
-def test_lcm(choosers, alternatives):
-    model = lcm.LocationChoiceModel(
+def test_mnl_lcm(choosers, alternatives):
+    model = lcm.MNLLocationChoiceModel(
         ['var3 != 15'], ['var2 != 14'], 'var2 + var1:var3', 5,
         name='Test LCM')
     loglik = model.fit(choosers, alternatives, choosers.thing_id)