metacountregressor 1.0.7__py3-none-any.whl → 1.0.9__py3-none-any.whl

metacountregressor/metaheuristics.py

@@ -266,7 +266,7 @@ def simulated_annealing(objective_function, initial_slns=None, **kwargs):
     #   TEMP_ALPHA, MAX_STEPS, INTL_ACCEPT, STEPS, SWAP_PERC, NUM_INTL_SLNS, IS_MULTI= hyperparameters
     man = None
     try:
-        objective_function.instance_number = str(0)
+        objective_function.instance_name = str(0)
     except:
         pass
     if 'Manual_Fit' in kwargs:
@@ -297,7 +297,7 @@ def harmony_search(objective_function, initial_harmonies=None, hyperparameters=N
     if kwargs.get('_hmcr') is not None:
         objective_function._hmcr = kwargs.get('_hmcr')
     try:
-        objective_function.instance_number = str(0)
+        objective_function.instance_name = f"run_hs_{str(0)}"
     except:
         pass
 
@@ -335,7 +335,7 @@ class Metaheuristic(object):
         self.F = kwargs['_AI']  # mustation scale
         self.iter = kwargs.get('_max_iter', 10000)
         self.cr = kwargs.get('_crossover_perc') or kwargs.get('_cr', 0.2)
-        self.instance_number = str(kwargs.get('instance_number', 1))
+        self.instance_name = str(kwargs.get('instance_name', 1))
         if objective_function.is_multi:
 
             self.obj_1 = objective_function._obj_1
@@ -424,7 +424,7 @@ class DifferentialEvolution(object):
     def __init__(self, objective_function, **kwargs):
         objective_function.algorithm = 'de'
         try:
-            objective_function.instance_number = str(0)
+            objective_function.instance_name = str(0)
         except:
             pass
         self._obj_fun = objective_function
@@ -442,8 +442,8 @@ class DifferentialEvolution(object):
         self.F = kwargs.get('_AI', 2)  # mutation scale
         self.iter = kwargs.get('_max_iter', 10000)
         self.cr = kwargs.get('_crossover_perc') or kwargs.get('_cr', 0.2)
-        self.instance_number = str(kwargs.get('instance_number', 1))
-        self.instance_number = objective_function.instance_number
+        self.instance_name = str(kwargs.get('instance_name', 1))
+        self.instance_name = objective_function.instance_name
         self.get_directory()
 
         self._population = list()
@@ -461,13 +461,13 @@ class DifferentialEvolution(object):
     def get_directory(self):
         # checking if the directory demo_folder2 
         # exist or not.
-        if not os.path.isdir(self.instance_number):
+        if not os.path.isdir(self.instance_name):
             # if the demo_folder2 directory is
             # not present then create it.
-            os.makedirs(self.instance_number)
+            os.makedirs(self.instance_name)
 
     def get_instance_name(self):
-        name = str(self.instance_number) + '/log.csv'
+        name = str(self.instance_name) + '/log.csv'
         return name
 
     def _random_selection(self, sln, i):
@@ -666,18 +666,18 @@ class DifferentialEvolution(object):
                         self._population[j] = obj_trial
                         
                         logger(self.it_process, obj_trial, self._population, True,
-                               self.instance_number + '/population_logger_strict_non_pareto.csv', 1)
+                               self.instance_name + '/population_logger_strict_non_pareto.csv', 1)
                         logger(self.it_process, obj_trial, self._pareto_population, True,
-                               self.instance_number + '/population_logger_pareto.csv', 1)
+                               self.instance_name + '/population_logger_pareto.csv', 1)
                     else:
                         if self.pf.calculate_difference(obj_trial, self._population[j]):
                             iterations_without_improvement = 0
                             self._population[j] = obj_trial
                             self._pareto_population = self.pf.Pareto_F
                             logger(self.it_process, obj_trial, self._population, True,
-                                   self.instance_number + '/population_logger_strict_non_pareto.csv', 1)
+                                   self.instance_name + '/population_logger_strict_non_pareto.csv', 1)
                             logger(self.it_process, obj_trial, self._pareto_population, True,
-                                   self.instance_number + '/population_logger_pareto.csv', 1)
+                                   self.instance_name + '/population_logger_pareto.csv', 1)
 
                     if it_best is None:
                         it_best = obj_trial
@@ -822,7 +822,7 @@ class SimulatedAnnealing(object):
         self.temp_min = 0.05
         self._MAX_ITERATIONS = int(kwargs.get('MAX_ITERATIONS', 10000)) or int(kwargs.get('_max_iter', 10000))
 
-        self.instance_number = str(objective_function.instance_number)
+        self.instance_name = str(objective_function.instance_name)
         self.accept = 0
         self.profiler = []
         self.update_t = self.cooling_linear_m
@@ -843,12 +843,12 @@ class SimulatedAnnealing(object):
     def get_directory(self):
         # checking if the directory demo_folder2 
         # exist or not.
-        if not os.path.isdir(self.instance_number):
+        if not os.path.isdir(self.instance_name):
             # not present then create it.
-            os.makedirs(self.instance_number)
+            os.makedirs(self.instance_name)
 
     def get_instance_name(self):
-        name = str(self.instance_number) + '/log.csv'
+        name = str(self.instance_name) + '/log.csv'
         return name
 
     def run(self, initial_slns=None, mod_init=None):
@@ -939,7 +939,7 @@ class SimulatedAnnealing(object):
                     didchange = self.pf.did_it_change()
                     if didchange:
                         pareto_logger(self.pf.Pareto_F, iteration, self._obj_fun.complexity_level,
-                                      self._obj_fun.instance_number)
+                                      self._obj_fun.instance_name)
                     self._current_energy = nbr_energy
                     self.current_struct = nbr_struct
                     self.accept += 1
@@ -1284,7 +1284,7 @@ class HarmonySearch(object):
         self.F = kwargs.get('_AI', 2)  # mutation scale
         self.iter = kwargs.get('_max_iter', 10000)
         self.cr = kwargs.get('_crossover_perc') or kwargs.get('_cr', 0.2)
-        self.instance_number = str(kwargs.get('instance_number', 1))
+        self.instance_name = str(kwargs.get('instance_name', 1))
 
 
 
@@ -1295,7 +1295,7 @@ class HarmonySearch(object):
         # harmony_history stores all hms harmonies every nth improvisations (i.e., one 'generation')
         self._harmony_history = list()
         # saves the best fitness
-        self.instance_number = str(objective_function.instance_number)
+        self.instance_name = str(objective_function.instance_name)
         self.get_directory()
         self._harmony_trace_best = list()
         self._harmony_trace_incumbent = list()
@@ -1315,13 +1315,13 @@ class HarmonySearch(object):
     def get_directory(self):
         # checking if the directory demo_folder2 
         # exist or not.
-        if not os.path.isdir(self.instance_number):
+        if not os.path.isdir(self.instance_name):
             # if the demo_folder2 directory is
             # not present then create it.
-            os.makedirs(self.instance_number)
+            os.makedirs(self.instance_name)
 
     def get_instance_name(self):
-        name = str(self.instance_number) + '/log.csv'
+        name = str(self.instance_name) + '/log.csv'
         return name
 
     def hard_mutate_index_and_value(self):
@@ -1432,7 +1432,7 @@ class HarmonySearch(object):
                                1)  # for consistency
                     except Exception as e:
                         print(e, 'logger run hs')
-                    # logger(num_imp, fitness, self._pareto_harmony_memory, True, self.instance_number +'/log_for_pareto_harmony_memory.csv', 1)
+                    # logger(num_imp, fitness, self._pareto_harmony_memory, True, self.instance_name +'/log_for_pareto_harmony_memory.csv', 1)
 
 
                 else:
@@ -1477,7 +1477,7 @@ class HarmonySearch(object):
 
                 else:
                     pareto_logger(self._pareto_harmony_memory, num_imp / self._obj_fun.get_hms(),
-                                  self._obj_fun.complexity_level, self._obj_fun.instance_number)
+                                  self._obj_fun.complexity_level, self._obj_fun.instance_name)
                 generation += 1
                 iterations_without_improvement += 1
 
@@ -1915,7 +1915,7 @@ class Mutlithreaded_Meta(DifferentialEvolution, SimulatedAnnealing, HarmonySearc
                         logger(num_imp, fitness, self._harmony_memory, True, self.get_instance_name(),
                                1)  # for consistency
                         logger(num_imp, fitness, self._pareto_harmony_memory, True,
-                               self.instance_number + '/log_for_pareto_harmony_memory.csv', 1)
+                               self.instance_name + '/log_for_pareto_harmony_memory.csv', 1)
 
 
                     else:
@@ -1960,7 +1960,7 @@ class Mutlithreaded_Meta(DifferentialEvolution, SimulatedAnnealing, HarmonySearc
 
                 else:
                     pareto_logger(self._pareto_harmony_memory, num_imp / self._obj_fun.get_hms(),
-                                  self._obj_fun.complexity_level, self._obj_fun.instance_number)
+                                  self._obj_fun.complexity_level, self._obj_fun.instance_name)
                 generation += 1
                 iterations_without_improvement += 1
 
@@ -2081,7 +2081,7 @@ class Mutlithreaded_Meta(DifferentialEvolution, SimulatedAnnealing, HarmonySearc
                         didchange = self.pf.did_it_change()
                         if didchange:
                             pareto_logger(self.pf.Pareto_F, iteration, self._obj_fun.complexity_level,
-                                          self._obj_fun.instance_number)
+                                          self._obj_fun.instance_name)
                         current_energy[j] = nbr_energy
 
                         self.accept += 1
@@ -2278,18 +2278,18 @@ class Mutlithreaded_Meta(DifferentialEvolution, SimulatedAnnealing, HarmonySearc
                         self._population[j] = obj_trial
 
                         logger(self.it_process, obj_trial, self._population, True,
-                               self.instance_number + '/population_logger_strict_non_pareto.csv', 1)
+                               self.instance_name + '/population_logger_strict_non_pareto.csv', 1)
                         logger(self.it_process, obj_trial, self._pareto_population, True,
-                               self.instance_number + '/population_logger_pareto.csv', 1)
+                               self.instance_name + '/population_logger_pareto.csv', 1)
                     else:
                         if self.pf.calculate_difference(obj_trial, self._population[j]):
                             iterations_without_improvement = 0
                             self._population[j] = obj_trial
                             self._pareto_population = self.pf.Pareto_F
                             logger(self.it_process, obj_trial, self._population, True,
-                                   self.instance_number + '/population_logger_strict_non_pareto.csv', 1)
+                                   self.instance_name + '/population_logger_strict_non_pareto.csv', 1)
                             logger(self.it_process, obj_trial, self._pareto_population, True,
-                                   self.instance_number + '/population_logger_pareto.csv', 1)
+                                   self.instance_name + '/population_logger_pareto.csv', 1)
 
                     if it_best is None:
                         it_best = obj_trial

metacountregressor/solution.py

@@ -212,19 +212,19 @@ class ObjectiveFunction(object):
         if 'complexity_level' in kwargs:
             self.complexity_level = kwargs['complexity_level']
 
-        if 'instance_number' in kwargs:
-            self.instance_number = str(kwargs['instance_number'])
+        if 'instance_name' in kwargs:
+            self.instance_name = str(kwargs['instance_name'])
         else:
             
             print('no name set, setting name as 0')
-            self.instance_number = str(0)  # set an arbitrary instance number
+            self.instance_name = f"run_{str(0)}"  # set an arbitrary instance number
 
         if kwargs.get('save_directory', True):
             self.save_state = True
-            if not os.path.exists(self.instance_number):
+            if not os.path.exists(self.instance_name):
                 if kwargs.get('make_directory', True):
                     print('Making a Directory, if you want to stop from storing the files to this directory set argumet: make_directory:False')
-                    os.makedirs(self.instance_number)
+                    os.makedirs(self.instance_name)
         else:
             self.save_state = False
         if not hasattr(self, '_obj_1'):
@@ -456,7 +456,7 @@ class ObjectiveFunction(object):
         self._transformations = kwargs.get('_transformations', ["no", "log", "sqrt", "arcsinh", "nil"])
         # self._distribution = ['triangular', 'uniform', 'normal', 'ln_normal', 'tn_normal', 'lindley']
 
-        self._distribution = kwargs.get('_distributions', ['triangular', 'uniform', 'normal', 'tn_normal'])
+        self._distribution = kwargs.get('_distributions', ['triangular', 'uniform', 'normal', 'tn_normal', 'ln_normal'])
 
         if self.G is not None:
             #TODO need to handle this for groups
@@ -1263,10 +1263,10 @@ class ObjectiveFunction(object):
                 caption = " ".join(caption_parts)
                 # print(latextable.draw_latex(table, caption=caption, caption_above = True))
                 if solution is None:
-                    file_name = self.instance_number + "/sln" + \
+                    file_name = self.instance_name + "/sln" + \
                                 "_with_BIC_" + str(self.bic) + ".tex"
                 else:
-                    file_name = self.instance_number + "/sln" + \
+                    file_name = self.instance_name + "/sln" + \
                                 str(solution['sol_num']) + \
                                 "_with_BIC_" + str(self.bic) + ".tex"
 

{metacountregressor-1.0.7.dist-info → metacountregressor-1.0.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metacountregressor
-Version: 1.0.7
+Version: 1.0.9
 Summary: Extensive Testing for Estimation of Data Count Models
 Home-page: https://github.com/zahern/CountDataEstimation
 Author: Zeke Ahern
@@ -30,8 +30,8 @@ Dynamic: requires-python
 Dynamic: summary
 
 <div style="display: flex; align-items: center;">
-    <img src="https://github.com/zahern/data/raw/main/m.png" alt="My Image" style="width: 100px; margin-right: 20px;">
-    <p><span style="font-size: 60px;"><strong>MetaCountRegressor</strong></span></p>
+    <img src="https://github.com/zahern/data/raw/main/m.png" alt="My Image" width="100">
+    <h1 style="margin-left: 20px;">MetaCountRegressor</h1>
 </div>
 
 # Tutorial also available as a jupyter notebook
@@ -39,6 +39,9 @@ Dynamic: summary
 
 The tutorial provides more extensive examples on how to run the code and perform experiments. Further documentation is currently in development.
 
+[Download Notebook Designed for Analysis Use Case](https://github.com/zahern/data/blob/main/Step%20By%20Step_Synthetic.ipynb)
+
+
 # For an Application Setup Download the following GUI
 [Download Application](https://github.com/zahern/MetaCount/tree/master/metacountregressor/application_gui/dist/meta_app)
 
@@ -95,7 +98,7 @@ X['Offset'] = np.log(df['AADT']) # Explicitley define how to offset the data, no
 X = df.drop(columns=['FREQ', 'ID', 'AADT'])  
 
 #some example argument, these are defualt so the following line is just for claritity. See the later agruments section for detials.
-arguments = {'algorithm': 'hs', 'test_percentage': 0.15, 'test_complexity': 6, 'instance_number':1,
+arguments = {'algorithm': 'hs', 'test_percentage': 0.15, 'test_complexity': 6, 'instance_name':1,
              'val_percentage':0.15, 'obj_1': 'bic', '_obj_2': 'RMSE_TEST', "_max_time": 6}
 # Fit the model with metacountregressor
 obj_fun = ObjectiveFunction(X, y, **arguments)
@@ -135,9 +138,9 @@ arguments = {
         'test_percentage': 0.2, # used in multi-objective optimisation only. Saves 20% of data for testing.
         'val_percenetage:': 0.2, # Saves 20% of data for testing.
         'test_complexity': 6, # Complexity level for testing (6 tests all) or a list to consider potential differences in complexity
-        'instance_number': 'name', # used for creeating a named folder where your models are saved into from the directory
+        'instance_name': 'name', # used for creeting a named folder where your models are saved into from the directory
         'distribution': ['Normal', 'LnNormal', 'Triangular', 'Uniform'],
-        'Model': [0,1],  # or equivalently ['POS', 'NB']
+        'model_types': [[0,1]],  # or equivalently ['POS', 'NB']
         'transformations': ['no', 'sqrt', 'archsinh'],
         'method_ll': 'BFGS_2',
         '_max_time': 10
@@ -156,7 +159,7 @@ manual_fit_spec = {
     'fixed_terms': ['SINGLE', 'LENGTH'],
     'rdm_terms': ['AADT:normal'],
     'rdm_cor_terms': ['GRADEBR:normal', 'CURVES:normal'],
-    'grouped_terms': [],
+    'grouped_rdm': [],
     'hetro_in_means': ['ACCESS:normal', 'MINRAD:normal'],
     'transformations': ['no', 'no', 'log', 'no', 'no', 'no', 'no'],
     'dispersion': 0
@@ -168,7 +171,7 @@ arguments = {
     'algorithm': 'hs',
     'test_percentage': 0.2,
     'test_complexity': 6,
-    'instance_number': 'name',
+    'instance_name': 'name',
     'Manual_Fit': manual_fit_spec
 }
 obj_fun = ObjectiveFunction(X, y, **arguments)
@@ -268,25 +271,22 @@ The following list describes the arguments available in this function. By defaul
 
 2. **`distributions`**: This argument accepts a list of strings where each string corresponds to a distribution. Valid options include:
     - "Normal"
-    - "Lindley"
     - "Uniform"
     - "LogNormal"
     - "Triangular"
-    - "Gamma"
     - "TruncatedNormal"
     - Any of the above, concatenated with ":" (e.g., "Normal:grouped"; requires a grouping term defined in the model)
 
 3. **`Model`**: This argument specifies the model form. It can be a list of integers representing different models to test:
     - 0: Poisson
     - 1: Negative-Binomial
-    - 2: Generalized-Poisson
 
 4. **`transformations`**: This argument accepts a list of strings representing available transformations within the framework. Valid options include:
     - "no"
     - "square-root"
     - "logarithmic"
     - "archsinh"
-    - "as_factor"
+    - "nil"
 
 5. **`is_multi`**: This argument accepts an integer indicating whether single or multiple objectives are to be tested (0 for single, 1 for multiple).
 
@@ -320,9 +320,9 @@ arguments = {
         'val_percentage:': 0.2, # Saves 20% of data for testing.
         'test_complexity': 3, # For Very simple Models
         'obj_1': 'BIC', '_obj_2': 'RMSE_TEST',
-        'instance_number': 'hs_run', # used for creeating a named folder where your models are saved into from the directory
+        'instance_name': 'hs_run', # used for creeating a named folder where your models are saved into from the directory
         'distribution': ['Normal'],
-        'Model': [0, 1],  # or equivalently ['POS', 'NB']
+        'model_types': [0, 1],  # or equivalently ['POS', 'NB']
         'transformations': ['no', 'sqrt', 'archsinh'],
         '_max_time': 10000
 } '''Arguments for the solution algorithm'''
@@ -398,7 +398,7 @@ manual_fit_spec = {
     'fixed_terms': ['const','YEAR'],
     'rdm_terms': [],
     'rdm_cor_terms': [],
-    'grouped_terms': [],
+    'grouped_rdm': [],
     'hetro_in_means': [],
     'transformations': ['no', 'no'],
     'dispersion': 1 #Negative Binomial 
@@ -410,7 +410,7 @@ arguments = {
     'algorithm': 'hs',
     'test_percentage': 0,
     'test_complexity': 6,
-    'instance_number': 'name',
+    'instance': 'name',
     'Manual_Fit': manual_fit_spec
 }
 obj_fun = ObjectiveFunction(data_exog, data_endog, **arguments)

{metacountregressor-1.0.7.dist-info → metacountregressor-1.0.9.dist-info}/RECORD

@@ -6,16 +6,16 @@ metacountregressor/halton.py,sha256=jhovA45UBoZYU9g-hl6Lb2sBIx_ZBTNdPrpgkzR9fng,
 metacountregressor/helperprocess.py,sha256=wW45-i31zy6rwaXt5PZt0GyR83PzF30jc9Wl4SQtnUI,26372
 metacountregressor/main.py,sha256=tGOm8DdbdyDf316qIxDAre6l6GzfJIWYNYIBaSeIemI,23685
 metacountregressor/main_old.py,sha256=eTS4ygq27MnU-dZ_j983Ucb-D5XfbVF8OJQK2hVVLZc,24123
-metacountregressor/metaheuristics.py,sha256=lAtDmQslzAC4Xg2Ozx4bnycz235le7-qEStlJFPa5xA,107881
+metacountregressor/metaheuristics.py,sha256=gVqJRNiHOa48-dHZxaJNgu2OLiYOpSYvWHJ1VFPqFWY,107817
 metacountregressor/pareto_file.py,sha256=whySaoPAUWYjyI8zo0hwAOa3rFk6SIUlHSpqZiLur0k,23096
 metacountregressor/pareto_logger__plot.py,sha256=mEU2QN4wmsM7t39GJ_XhJ_jjsdl09JOmG0U2jICrAkI,30037
 metacountregressor/setup.py,sha256=5UcQCCLR8Fm5odA3MX78WwahavxFq4mVD6oq0IuQvAY,936
 metacountregressor/single_objective_finder.py,sha256=jVG7GJBqzSP4_riYr-kMMKy_LE3SlGmKMunNhHYxgRg,8011
-metacountregressor/solution.py,sha256=nY9L3X3mBUqbIopriHIzp9zXQOdhSt8dWj4Nx5Gu40Y,324648
+metacountregressor/solution.py,sha256=faNERJD_8ubf37CgRqHTM0YsJBzSp0LXhj0kArWeCIE,324654
 metacountregressor/test_code.py,sha256=_7Emm2JbhK_NVhxoqMhshN2JeHZtihZuSDl3Jpe7Ajk,1641
 metacountregressor/test_generated_paper2.py,sha256=pwOoRzl1jJIIOUAAvbkT6HmmTQ81mwpsshn9SLdKOg8,3927
-metacountregressor-1.0.7.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-metacountregressor-1.0.7.dist-info/METADATA,sha256=3-FuTS2ap0lEcxzmCiGjO6825DoAAqNuEuaEeaWVbnY,23618
-metacountregressor-1.0.7.dist-info/WHEEL,sha256=ooBFpIzZCPdw3uqIQsOo4qqbA4ZRPxHnOH7peeONza0,91
-metacountregressor-1.0.7.dist-info/top_level.txt,sha256=zGG7UC5WIpr76gsFUpwJ4En2aCcoNTONBaS3OewwjR0,19
-metacountregressor-1.0.7.dist-info/RECORD,,
+metacountregressor-1.0.9.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+metacountregressor-1.0.9.dist-info/METADATA,sha256=Dc5IChtucF9hMxMi1YbYR93TQzWEaDDB3j_pxjyRsJ0,23619
+metacountregressor-1.0.9.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+metacountregressor-1.0.9.dist-info/top_level.txt,sha256=zGG7UC5WIpr76gsFUpwJ4En2aCcoNTONBaS3OewwjR0,19
+metacountregressor-1.0.9.dist-info/RECORD,,

{metacountregressor-1.0.7.dist-info → metacountregressor-1.0.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.0.1)
+Generator: setuptools (80.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any