ale_ruby_interface 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 460fc42c858e6b2e6e280e3aef39ce81597e49ca
-  data.tar.gz: e096cd1c6227c663e3ff24f7b661586b8d09bdb7
+  metadata.gz: 7d5774428a94d5e51002236d6baaeef5c7042d52
+  data.tar.gz: f076b50123171066497e1698ab90d7801cada3bd
 SHA512:
-  metadata.gz: 94f1348040a3e64c02d6b00fb3b2788b649df46b446cbdcb891bc898c6c105096d12546f7be66e5f76494e53838019723fe708907b4588d6b9996fc3f1764504
-  data.tar.gz: 650dbc2e4916accbfd91ee4283146881b4efe9831cd442ab308ca7e1d621e3cac3b9b41e3959075c1f626ba4936ed5c333069103a2e137ad44d90e843eb6ecca
+  metadata.gz: 4eea742eaf9a6bdd04612cd0d50635b255267beef11f355c982be4b17595223c43b25b48ea8756e674dfbb96a213cbb5250632924ce481960822303e9f09506f
+  data.tar.gz: d4eac2d449b0f52a1d6ca68b7d03de446f6c4047fd943a3a116291405f4a1ff51ba72adc409efd90f7d5a82f957f2586ff44e60d5c3b56ca29252e3baefdf2d8

data/lib/ale_ruby_interface.rb

@@ -2,11 +2,10 @@ require 'ffi'
 require 'nmatrix'
 require 'fileutils'
 
+##
+# Module for connecting to libale_c.so
 module ALELib
   extend FFI::Library
-  # ffi_lib '/Users/happybai/Arcade-Learning-Environment/ale_python_interface/libale_c.so'
-  # ffi_lib File.expand_path(File.join(File.dirname(__FILE__), "lib", "libale_c.so"))
-  # ffi_lib './lib/libale_c.so'
   ffi_lib File.join(File.dirname(__FILE__), "libale_c.so")
   attach_function :ALE_new, [], :pointer
   attach_function :ALE_del, [:pointer], :pointer
@@ -56,12 +55,15 @@ module ALELib
   attach_function :setLoggerMode, [:int], :pointer
 end
 
+##
+# This is the main class
+
 class ALEInterface
+
+  ##
+  # initialize method
   def initialize
-    # setup config file manually
-    # ale_path = ENV['ale_path'] || '/Users/happybai/Arcade-Learning-Environment'
-    # base_path = "#{Dir.pwd}/lib"
-    # Dir.chdir base_path
+    # if ale.cfg doesn't exist, will create one.
     src = File.join(File.dirname(__FILE__), "ale.cfg")
     dest = './ale.cfg'
     if !File.exist?('./ale.cfg')
@@ -69,57 +71,84 @@ class ALEInterface
       puts "Created ale.cfg successfully"
     end
     @obj = ALELib.ALE_new
-    # Dir.chdir base_path
   end
 
+  ##
+  # Gets the value of any flag passed as parameter that has a string value
   def get_string(key)
     ALELib.getString(@obj, key)
   end
 
+  ##
+  # Gets the value of any flag passed as parameter that has an integer value
   def get_int(key)
     ALELib.getInt(@obj, key)
   end
 
+  ##
+  # Gets the value of any flag passed as parameter that has a boolean value
   def get_bool(key)
     ALELib.getBool(@obj, key)
   end
 
+  ##
+  # Gets the value of any flag passed as parameter that has a float value
   def get_float(key)
     ALELib.getFloat(@obj, key)
   end
 
+  ##
+  # Sets the value of any flag that has a string type
   def set_string(key, value)
     ALELib.setString(@obj, key, value)
   end
 
+  ##
+  # Sets the value of any flag that has an integer type
   def set_int(key, value)
     ALELib.setInt(@obj, key, value)
   end
 
+  ##
+  # Sets the value of any flag that has a boolean type
   def set_bool(key, value)
     ALELib.setBool(@obj, key, value)
   end
 
+  ##
+  # Sets the value of any flag that has a float type
   def set_float(key, value)
     ALELib.setFloat(@obj, key, value)
   end
 
+  ##
+  # TODO: load_ROM method
   def load_ROM(rom_file)
     ALELib.loadROM(@obj, rom_file)
   end
 
+  ##
+  # Applies an action to the game and returns the reward.
+  # It is the user’s responsibility to check if the game has ended and to reset it when necessary (this method will keep pressing buttons on the game over screen).
   def act(action)
     ALELib.act(@obj, action.to_i)
   end
 
+  ##
+  # Indicates if the game has ended.
   def game_over
     ALELib.game_over(@obj)
   end
 
+  ##
+  # Resets the game, but not the full system (it is not “equivalent” to un- plugging the console from electricity).
   def reset_game
     ALELib.game_over(@obj)
   end
 
+  ##
+  # Returns the vector of legal actions (all the 18 actions).
+  # This should be called only after the ROM is loaded.
   def get_legal_action_set
     act_size = ALELib.getLegalActionSize(@obj)
     act = NMatrix.zeros [act_size]
@@ -130,6 +159,9 @@ class ALEInterface
     end
   end
 
+  ##
+  # Returns the vector of the minimal set of actions needed to play the game (all actions that have some effect on the game).
+  # This should be called only after the ROM is loaded.
   def get_minimal_action_set
     act_size = ALELib.getMinimalActionSize(@obj)
     act = NMatrix.zeros [act_size]
@@ -140,6 +172,9 @@ class ALEInterface
     end
   end
 
+  ##
+  # Returns the vector of modes available for the current game.
+  # This should be called only after the ROM is loaded.
   def get_available_modes
     modes_size = ALELib.getAvailableModesSize(@obj)
     modes = NMatrix.zeros [modes_size]
@@ -150,10 +185,16 @@ class ALEInterface
     end
   end
 
+  ##
+  # Sets the mode of the game. The mode must be an available mode (otherwise it throws an exception).
+  # This should be called only after the ROM is loaded.
   def set_mode(mode)
     ALELib.set_mode(@obj, mode)
   end
 
+  ##
+  # Returns the vector of difficulties available for the current game.
+  # This should be called only after the ROM is loaded.
   def get_available_difficulties
     difficulties_size = ALELib.getAvailableDifficultiesSize(@obj)
     difficulties = NMatrix.zeros [difficulties_size]
@@ -164,28 +205,41 @@ class ALEInterface
     end
   end
 
+  ##
+  # Sets the difficulty of the game. The difficulty must be an available mode (otherwise it throws an exception).
+  # This should be called only after the ROM is loaded.
   def set_difficulty(difficulty)
     ALELib.set_mode(@obj, difficulty)
   end
 
+  ##
+  # Returns the current frame number since the loading of the ROM.
   def get_frame_number
     ALELib.getFrameNumber(@obj)
   end
 
+  ##
+  # Returns the agent’s remaining number of lives. If the game does not have the concept of lives (e.g. Freeway), this function returns 0.
   def lives
     ALELib.lives(@obj)
   end
 
+  ##
+  # Returns the current frame number since the start of the cur- rent episode.
   def get_episode_frame_number
     ALELib.getEpisodeFrameNumber(@obj)
   end
 
+  ##
+  # get_screen_dims method
   def get_screen_dims
     width = ALELib.getScreenWidth(@obj)
     height = ALELib.getScreenHeight(@obj)
     { width: width, height: height }
   end
 
+  ##
+  # Returns a matrix containing the current game screen.
   def get_screen(screen_data = nil)
     # This function fills screen_data with the RAW Pixel data
     width = ALELib.getScreenWidth(@obj)
@@ -201,6 +255,8 @@ class ALEInterface
     end
   end
 
+  ##
+  # This method fills the given vector with a RGB version of the current screen, provided in row, column, then colour channel order (typically yielding 210 × 160 × 3 = 100, 800 entries). The colour channels themselves are, in order: R, G, B. For example, output_rgb_buffer[(160 * 3) * 1 + 52 * 3 + 1] corresponds to the 2nd row, 53rd column pixel’s green value. The vector is resized as needed. Still, for efficiency it is recommended to initialize the vector beforehand, to make sure an allocation is not performed at each time step.
   def get_screen_RGB()
     # This function fills screen_data with the data in RGB format
     width = ALELib.getScreenWidth(@obj)
@@ -216,6 +272,8 @@ class ALEInterface
     end
   end
 
+  ##
+  # This method fills the given vector with a grayscale version of the current screen, provided in row- major order (typically yielding 210 × 160 = 33, 600 entries). The vector is resized as needed. For efficiency it is recommended to initialize the vector beforehand, to make sure an allocation is not performed at each time step. Note that the grayscale value corresponds to the pixel’s luminance; for more details, consult the web.
   def get_screen_grayscale(screen_data = nil)
     width = ALELib.getScreenWidth(@obj)
     height = ALELib.getScreenHeight(@obj)
@@ -230,10 +288,14 @@ class ALEInterface
     end
   end
 
+  ##
+  # get_RAM_size method
   def get_RAM_size
     ALELib.getRAMSize(@obj)
   end
 
+  ##
+  # Returns a vector containing current RAM content (byte-level).
   def get_RAM()
     ram_size = ALELib.getRAMSize(@obj)
     FFI::MemoryPointer.new(:uint64, ram_size) do |p|
@@ -246,48 +308,66 @@ class ALEInterface
     end
   end
 
+  ##
+  # Saves the current screen as a png file.
   def save_screen_PNG(filename)
     return ALELib.saveScreenPNG(@obj, filename)
   end
 
+  ##
+  # Saves the current state of the system if one wants to be able to recover a state in the future; e.g. in search algorithms.
   def save_state
     return ALELib.saveState(@obj)
   end
 
+  ##
+  # Loads a previous saved state of the system once we have a state saved.
   def load_state
     return ALELib.loadState(@obj)
   end
 
+  ##
+  # Makes a copy of the environment state. This copy does not include pseudo-randomness, making it suitable for planning purposes. By contrast, see cloneSystemState.
   def clone_state
-    # This makes a copy of the environment state. This copy does *not*
-    # include pseudorandomness, making it suitable for planning
-    # purposes. By contrast, see cloneSystemState.
     return ALELib.cloneState(@obj)
   end
 
+  ##
+  # Reverse operation of cloneState(). This does not restore pseudo-randomness, so that repeated calls to restoreState() in the stochastic controls setting will not lead to the same outcomes. By contrast, see restoreSystemState.
   def restore_state(state)
     ALELib.restoreState(@obj, state)
   end
 
+  ##
+  # This makes a copy of the system and environment state, suitable for serialization. This includes pseudo-randomness and so is not suitable for planning purposes.
   def clone_system_state
     return ALELib.cloneSystemState(@obj)
   end
 
+  ##
+  # Reverse operation of cloneSystemState.
   def restore_system_state
     ALELib.restoreSystemState(@obj)
   end
 
+  ##
+  # delete_state method
   def delete_state(state)
     ALELib.deleteState(state)
   end
 
+  ##
+  # encode_state_len method
   def encode_state_len(state)
     return ALELib.encodeStateLen(state)
   end
 
-  # TBD
+  ##
+  # encode_staten method
   def encode_state; end
 
+  ##
+  # encode_staten method
   def decode_state; end
 
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ale_ruby_interface
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Byron Bai