rename classes

automata.py

@@ -32,10 +32,16 @@ version = major + 0.1*minor
 OLD_PY_VERSION = 1 if version < 3.8 else 0
 
 _CITATION = """\
+@article{liu2022transformers,
+  title={Transformers learn shortcuts to automata},
+  author={Liu, Bingbin and Ash, Jordan T and Goel, Surbhi and Krishnamurthy, Akshay and Zhang, Cyril},
+  journal={arXiv preprint arXiv:2210.10749},
+  year={2022}
+}
 """
 
 _DESCRIPTION = """\
-Online dataset mockup.
+Non-autoregressive automaton simulation datasets.
 """
 
 _HOMEPAGE = ""
@@ -44,7 +50,7 @@ _LICENSE = ""
 
 _URLS = {}
 
-class SyntheticAutomataDataset(datasets.GeneratorBasedBuilder):
+class AutomatonDataset(datasets.GeneratorBasedBuilder):
     """TODO: Short description of my dataset."""
 
     VERSION = datasets.Version("0.0.0")
@@ -64,7 +70,7 @@ class SyntheticAutomataDataset(datasets.GeneratorBasedBuilder):
             config['size'] = -1
 
         self.data_config = config
-        self.sampler = dataset_map[config['name']](config)
+        self.automaton = dataset_map[config['name']](config)
 
     def _info(self):
         features = datasets.Features(
@@ -96,14 +102,13 @@ class SyntheticAutomataDataset(datasets.GeneratorBasedBuilder):
         for i in itertools.count(start=0):
             if i == self.data_config['size']:
                 break
-            x, y = self.sampler.sample()
+            x, y = self.automaton.sample()
             yield i, {
                 "input_ids": x,
                 "label_ids": y
             }
 
-
-class AutomatonSampler:
+class Automaton:
   """
   This is a parent class that must be inherited.
   """
@@ -144,13 +149,10 @@ class AutomatonSampler:
   def help(self):
         print(self.__info__)
 
-
-
-
-class BinaryInputSampler(AutomatonSampler):
+class BinaryInputAutomaton(Automaton):
   """
   This is a parent class that must be inherited.
-  Subclasses: ParitySampler, GridworldSampler, ABABSampler
+  Subclasses: ParityAutomaton, GridworldAutomaton, ABABAutomaton
 
   TODO: sample sequences with a given number of 1s
   """
@@ -171,7 +173,7 @@ class BinaryInputSampler(AutomatonSampler):
     x = self.np_rng.binomial(1, self.prob1, size=T)
     return x, self.f(x)
 
-class ParitySampler(BinaryInputSampler):
+class ParityAutomaton(BinaryInputAutomaton):
   def __init__(self, data_config):
     super().__init__(data_config)
     self.name = 'parity'
@@ -185,7 +187,7 @@ class ParitySampler(BinaryInputSampler):
   def f(self, x):
     return np.cumsum(x) % 2
 
-class GridworldSampler(BinaryInputSampler):
+class GridworldAutomaton(BinaryInputAutomaton):
   """
   Note: gridworld currently doesn't include a no-op.
   """
@@ -234,7 +236,7 @@ class GridworldSampler(BinaryInputSampler):
     return np.array(states).astype(np.int64)
 
 
-class ABABSampler(BinaryInputSampler):
+class ABABAutomaton(BinaryInputAutomaton):
   def __init__(self, data_config):
     super().__init__(data_config)
     self.name = 'abab'
@@ -290,7 +292,7 @@ class ABABSampler(BinaryInputSampler):
       return super().sample()
 
 
-class AdderSampler(BinaryInputSampler):
+class AdderAutomaton(BinaryInputAutomaton):
   def __init__(self, data_config):
     super().__init__(data_config)
     self.name = 'addition'
@@ -351,7 +353,7 @@ class AdderSampler(BinaryInputSampler):
     return x_encode, self.f(x)
 
 
-class FlipFlopSampler(AutomatonSampler):
+class FlipFlopAutomaton(Automaton):
   def __init__(self, data_config):
     super().__init__(data_config)
     self.name = 'flipflop'
@@ -388,10 +390,10 @@ class FlipFlopSampler(AutomatonSampler):
 
 
 
-class PermutationSampler(AutomatonSampler):
+class PermutationAutomaton(Automaton):
   """
   This is a parent class that must be inherited.
-  Subclasses: SymmetricSampler, AlternatingSampler
+  Subclasses: SymmetricAutomaton, AlternatingAutomaton
   """
   def __init__(self, data_config):
     super().__init__(data_config)
@@ -436,7 +438,7 @@ class PermutationSampler(AutomatonSampler):
     return x, self.f(x)
 
 
-class SymmetricSampler(PermutationSampler):
+class SymmetricAutomaton(PermutationAutomaton):
   """
   TODO: add options for labels as functions of states
   - parity (whether a state is even): this may need packages (e.g. Permutation from sympy)
@@ -494,7 +496,7 @@ class SymmetricSampler(PermutationSampler):
         + self.__info__ 
 
 
-class AlternatingSampler(PermutationSampler):
+class AlternatingAutomaton(PermutationAutomaton):
   """
   TODO: other choices of generators (currently using (12x))?
   """
@@ -537,7 +539,7 @@ class AlternatingSampler(PermutationSampler):
 
 
 
-class CyclicSampler(AutomatonSampler):
+class CyclicAutomaton(Automaton):
   def __init__(self, data_config):
     super().__init__(data_config)
 
@@ -575,7 +577,7 @@ class CyclicSampler(AutomatonSampler):
     return x, self.f(x)
 
 
-class DihedralSampler(AutomatonSampler):
+class DihedralAutomaton(Automaton):
   def __init__(self, data_config):
     super().__init__(data_config)
 
@@ -665,7 +667,7 @@ class DihedralSampler(AutomatonSampler):
 
 
 
-class QuaternionSampler(AutomatonSampler):
+class QuaternionAutomaton(Automaton):
   def __init__(self, data_config):
     super().__init__(data_config)
 
@@ -700,7 +702,7 @@ class QuaternionSampler(AutomatonSampler):
     return x, self.f(x)
 
 
-class PermutationResetSampler(AutomatonSampler):
+class PermutationResetAutomaton(Automaton):
   def __init__(self, data_config):
     super().__init__(data_config)
 
@@ -751,17 +753,16 @@ class PermutationResetSampler(AutomatonSampler):
 
 
 dataset_map = {
-  'abab': ABABSampler,
-  'add': AdderSampler,
-  'alternating': AlternatingSampler,
-  'cyclic': CyclicSampler,
-  'dihedral': DihedralSampler,
-  'flipflop': FlipFlopSampler,
-  'gridworld': GridworldSampler,
-  'parity': ParitySampler,
-  'quaternion': QuaternionSampler,
-  'symmetric': SymmetricSampler,
-  'permutation_reset': PermutationResetSampler
+  'abab': ABABAutomaton,
+  'add': AdderAutomaton,
+  'alternating': AlternatingAutomaton,
+  'cyclic': CyclicAutomaton,
+  'dihedral': DihedralAutomaton,
+  'flipflop': FlipFlopAutomaton,
+  'gridworld': GridworldAutomaton,
+  'parity': ParityAutomaton,
+  'quaternion': QuaternionAutomaton,
+  'symmetric': SymmetricAutomaton,
+  'permutation_reset': PermutationResetAutomaton
   # TODO: add Dyck
   }
-