License	MIT
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

OpenAI.Gym.Data

Description

Aeson-based data types to be returned by OpenAI.Gym.API

Synopsis

data GymEnv
- = CartPoleV0
- | CartPoleV1
- | AcrobotV1
- | MountainCarV0
- | MountainCarContinuousV0
- | PendulumV0
- | FrozenLakeV0
- | PongRamV0
- | PongV0
newtype InstID = InstID {
- getInstID :: Text
}
newtype Environment = Environment {
- all_envs :: HashMap Text Text
}
newtype Observation = Observation {
- getObservation :: Value
}
data Step = Step {
- action :: !Value
- render :: !Bool
}
data Outcome = Outcome {
- observation :: !Value
- reward :: !Double
- done :: !Bool
- info :: !Object
}
newtype Info = Info {
- getInfo :: Object
}
newtype Action = Action {
- getAction :: Value
}
data Monitor = Monitor {
- directory :: !Text
- force :: !Bool
- resume :: !Bool
- video_callable :: !Bool
}
data Config = Config {
- training_dir :: !Text
- algorithm_id :: !Text
- api_key :: !Text
}

Documentation

data GymEnv #

Classic Control Environments

Constructors

CartPoleV0	Balance a pole on a cart (for a short time).
CartPoleV1	Balance a pole on a cart.
AcrobotV1	Swing up a two-link robot.
MountainCarV0	Drive up a big hill.
MountainCarContinuousV0	Drive up a big hill with continuous control.
PendulumV0	Swing up a pendulum.
FrozenLakeV0	Swing up a pendulum.
PongRamV0	Maximize score in the game Pong, with RAM as input
PongV0	Maximize score in the game Pong

Instances

Enum GymEnv #
Instance details Defined in OpenAI.Gym.Data Methods succ :: GymEnv -> GymEnv # pred :: GymEnv -> GymEnv # toEnum :: Int -> GymEnv # fromEnum :: GymEnv -> Int # enumFrom :: GymEnv -> [GymEnv] # enumFromThen :: GymEnv -> GymEnv -> [GymEnv] # enumFromTo :: GymEnv -> GymEnv -> [GymEnv] # enumFromThenTo :: GymEnv -> GymEnv -> GymEnv -> [GymEnv] #
Eq GymEnv #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: GymEnv -> GymEnv -> Bool # (/=) :: GymEnv -> GymEnv -> Bool #
Ord GymEnv #
Instance details Defined in OpenAI.Gym.Data Methods compare :: GymEnv -> GymEnv -> Ordering # (<) :: GymEnv -> GymEnv -> Bool # (<=) :: GymEnv -> GymEnv -> Bool # (>) :: GymEnv -> GymEnv -> Bool # (>=) :: GymEnv -> GymEnv -> Bool # max :: GymEnv -> GymEnv -> GymEnv # min :: GymEnv -> GymEnv -> GymEnv #
Show GymEnv #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> GymEnv -> ShowS # show :: GymEnv -> String # showList :: [GymEnv] -> ShowS #
ToJSON GymEnv #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: GymEnv -> Value # toEncoding :: GymEnv -> Encoding # toJSONList :: [GymEnv] -> Value # toEncodingList :: [GymEnv] -> Encoding #

newtype InstID #

a short identifier (such as '3c657dbc') for the created environment instance. The instance_id is used in future API calls to identify the environment to be manipulated.

Constructors

InstID
Fields getInstID :: Text

Instances

Eq InstID #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: InstID -> InstID -> Bool # (/=) :: InstID -> InstID -> Bool #
Show InstID #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> InstID -> ShowS # show :: InstID -> String # showList :: [InstID] -> ShowS #
Generic InstID #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep InstID :: * -> * # Methods from :: InstID -> Rep InstID x # to :: Rep InstID x -> InstID #
ToJSON InstID #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: InstID -> Value # toEncoding :: InstID -> Encoding # toJSONList :: [InstID] -> Value # toEncodingList :: [InstID] -> Encoding #
FromJSON InstID #
Instance details Defined in OpenAI.Gym.Data Methods parseJSON :: Value -> Parser InstID # parseJSONList :: Value -> Parser [InstID] #
ToHttpApiData InstID #
Instance details Defined in OpenAI.Gym.Data Methods toUrlPiece :: InstID -> Text # toEncodedUrlPiece :: InstID -> Builder # toHeader :: InstID -> ByteString # toQueryParam :: InstID -> Text #
type Rep InstID #
Instance details Defined in OpenAI.Gym.Data type Rep InstID = D1 (MetaData "InstID" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" True) (C1 (MetaCons "InstID" PrefixI True) (S1 (MetaSel (Just "getInstID") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype Environment #

a mapping of instance_id to env_id (e.g. {'3c657dbc': 'CartPole-v0'}) for every env on the server

Constructors

Environment
Fields all_envs :: HashMap Text Text

Instances

Eq Environment #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: Environment -> Environment -> Bool # (/=) :: Environment -> Environment -> Bool #
Show Environment #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> Environment -> ShowS # show :: Environment -> String # showList :: [Environment] -> ShowS #
Generic Environment #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep Environment :: * -> * # Methods from :: Environment -> Rep Environment x # to :: Rep Environment x -> Environment #
ToJSON Environment #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: Environment -> Value # toEncoding :: Environment -> Encoding # toJSONList :: [Environment] -> Value # toEncodingList :: [Environment] -> Encoding #
FromJSON Environment #
Instance details Defined in OpenAI.Gym.Data Methods parseJSON :: Value -> Parser Environment # parseJSONList :: Value -> Parser [Environment] #
type Rep Environment #
Instance details Defined in OpenAI.Gym.Data type Rep Environment = D1 (MetaData "Environment" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" True) (C1 (MetaCons "Environment" PrefixI True) (S1 (MetaSel (Just "all_envs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap Text Text))))

newtype Observation #

The agent's observation of the current environment

Constructors

Observation
Fields getObservation :: Value

Instances

Eq Observation #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: Observation -> Observation -> Bool # (/=) :: Observation -> Observation -> Bool #
Show Observation #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> Observation -> ShowS # show :: Observation -> String # showList :: [Observation] -> ShowS #
Generic Observation #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep Observation :: * -> * # Methods from :: Observation -> Rep Observation x # to :: Rep Observation x -> Observation #
ToJSON Observation #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: Observation -> Value # toEncoding :: Observation -> Encoding # toJSONList :: [Observation] -> Value # toEncodingList :: [Observation] -> Encoding #
FromJSON Observation #
Instance details Defined in OpenAI.Gym.Data Methods parseJSON :: Value -> Parser Observation # parseJSONList :: Value -> Parser [Observation] #
type Rep Observation #
Instance details Defined in OpenAI.Gym.Data type Rep Observation = D1 (MetaData "Observation" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" True) (C1 (MetaCons "Observation" PrefixI True) (S1 (MetaSel (Just "getObservation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Value)))

data Step #

An action to take in the environment and whether or not to render that change

Constructors

Step
Fields action :: !Value render :: !Bool

Instances

Eq Step #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: Step -> Step -> Bool # (/=) :: Step -> Step -> Bool #
Show Step #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> Step -> ShowS # show :: Step -> String # showList :: [Step] -> ShowS #
Generic Step #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep Step :: * -> * # Methods from :: Step -> Rep Step x # to :: Rep Step x -> Step #
ToJSON Step #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: Step -> Value # toEncoding :: Step -> Encoding # toJSONList :: [Step] -> Value # toEncodingList :: [Step] -> Encoding #
type Rep Step #
Instance details Defined in OpenAI.Gym.Data type Rep Step = D1 (MetaData "Step" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" False) (C1 (MetaCons "Step" PrefixI True) (S1 (MetaSel (Just "action") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Value) :*: S1 (MetaSel (Just "render") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))

data Outcome #

The result of taking a step in an environment

Constructors

Outcome
Fields observation :: !Value agent's observation of the current environment reward :: !Double amount of reward returned after previous action done :: !Bool whether the episode has ended info :: !Object a dict containing auxiliary diagnostic information

Instances

Eq Outcome #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: Outcome -> Outcome -> Bool # (/=) :: Outcome -> Outcome -> Bool #
Show Outcome #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> Outcome -> ShowS # show :: Outcome -> String # showList :: [Outcome] -> ShowS #
Generic Outcome #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep Outcome :: * -> * # Methods from :: Outcome -> Rep Outcome x # to :: Rep Outcome x -> Outcome #
ToJSON Outcome #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: Outcome -> Value # toEncoding :: Outcome -> Encoding # toJSONList :: [Outcome] -> Value # toEncodingList :: [Outcome] -> Encoding #
FromJSON Outcome #
Instance details Defined in OpenAI.Gym.Data Methods parseJSON :: Value -> Parser Outcome # parseJSONList :: Value -> Parser [Outcome] #
type Rep Outcome #
Instance details Defined in OpenAI.Gym.Data type Rep Outcome = D1 (MetaData "Outcome" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" False) (C1 (MetaCons "Outcome" PrefixI True) ((S1 (MetaSel (Just "observation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Value) :: S1 (MetaSel (Just "reward") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Double)) :: (S1 (MetaSel (Just "done") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :*: S1 (MetaSel (Just "info") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Object))))

newtype Info #

A dict containing auxiliary diagnostic information

Constructors

Info
Fields getInfo :: Object

Instances

Eq Info #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: Info -> Info -> Bool # (/=) :: Info -> Info -> Bool #
Show Info #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> Info -> ShowS # show :: Info -> String # showList :: [Info] -> ShowS #
Generic Info #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep Info :: * -> * # Methods from :: Info -> Rep Info x # to :: Rep Info x -> Info #
ToJSON Info #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: Info -> Value # toEncoding :: Info -> Encoding # toJSONList :: [Info] -> Value # toEncodingList :: [Info] -> Encoding #
FromJSON Info #
Instance details Defined in OpenAI.Gym.Data Methods parseJSON :: Value -> Parser Info # parseJSONList :: Value -> Parser [Info] #
type Rep Info #
Instance details Defined in OpenAI.Gym.Data type Rep Info = D1 (MetaData "Info" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" True) (C1 (MetaCons "Info" PrefixI True) (S1 (MetaSel (Just "getInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Object)))

newtype Action #

An action to take in the environment

Constructors

Action
Fields getAction :: Value

Instances

Eq Action #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
Show Action #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
Generic Action #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep Action :: * -> * # Methods from :: Action -> Rep Action x # to :: Rep Action x -> Action #
ToJSON Action #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: Action -> Value # toEncoding :: Action -> Encoding # toJSONList :: [Action] -> Value # toEncodingList :: [Action] -> Encoding #
FromJSON Action #
Instance details Defined in OpenAI.Gym.Data Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] #
type Rep Action #
Instance details Defined in OpenAI.Gym.Data type Rep Action = D1 (MetaData "Action" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" True) (C1 (MetaCons "Action" PrefixI True) (S1 (MetaSel (Just "getAction") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Value)))

data Monitor #

Parameters used to start a monitoring session.

Constructors

Monitor

Fields

directory :: !Text
directory to use for monitoring
force :: !Bool
Clear out existing training data from this directory (by deleting every file prefixed with "openaigym.") (default=False)
resume :: !Bool
Retain the training data already in this directory, which will be merged with our new data. (default=False)
video_callable :: !Bool
video_callable parameter from the native env.monitor.start function

Instances

Eq Monitor #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: Monitor -> Monitor -> Bool # (/=) :: Monitor -> Monitor -> Bool #
Show Monitor #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> Monitor -> ShowS # show :: Monitor -> String # showList :: [Monitor] -> ShowS #
Generic Monitor #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep Monitor :: * -> * # Methods from :: Monitor -> Rep Monitor x # to :: Rep Monitor x -> Monitor #
ToJSON Monitor #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: Monitor -> Value # toEncoding :: Monitor -> Encoding # toJSONList :: [Monitor] -> Value # toEncodingList :: [Monitor] -> Encoding #
type Rep Monitor #
Instance details Defined in OpenAI.Gym.Data type Rep Monitor = D1 (MetaData "Monitor" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" False) (C1 (MetaCons "Monitor" PrefixI True) ((S1 (MetaSel (Just "directory") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "force") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) :: (S1 (MetaSel (Just "resume") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :*: S1 (MetaSel (Just "video_callable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))

data Config #

Parameters used to upload a monitored session to OpenAI's servers

Constructors

Config
Fields training_dir :: !Text A directory containing the results of a training run. algorithm_id :: !Text An arbitrary string indicating the paricular version of the algorithm (including choices of parameters) you are running. (default=None) api_key :: !Text Your OpenAI API key

Instances

Eq Config #
Instance details Defined in OpenAI.Gym.Data Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config #
Instance details Defined in OpenAI.Gym.Data Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Generic Config #
Instance details Defined in OpenAI.Gym.Data Associated Types type Rep Config :: * -> * # Methods from :: Config -> Rep Config x # to :: Rep Config x -> Config #
ToJSON Config #
Instance details Defined in OpenAI.Gym.Data Methods toJSON :: Config -> Value # toEncoding :: Config -> Encoding # toJSONList :: [Config] -> Value # toEncodingList :: [Config] -> Encoding #
type Rep Config #
Instance details Defined in OpenAI.Gym.Data type Rep Config = D1 (MetaData "Config" "OpenAI.Gym.Data" "gym-http-api-0.1.0.1-GBHZzBvJwr3LixGOqfeVcJ" False) (C1 (MetaCons "Config" PrefixI True) (S1 (MetaSel (Just "training_dir") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "algorithm_id") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "api_key") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))