| Copyright | (c) Jiasen Wu 2020 |
|---|---|
| License | BSD-3-Clause |
| Safe Haskell | None |
| Language | Haskell2010 |
Neptune.Client
Description
Synopsis
- data Parameter
- createExperiment :: HasCallStack => NeptuneSession -> Maybe Text -> Maybe Text -> [Parameter] -> [(Text, Text)] -> [Text] -> IO Experiment
- nlog :: (HasCallStack, NeptDataType a) => Experiment -> Text -> a -> IO ()
- withNept :: Text -> (NeptuneSession -> Experiment -> IO a) -> IO a
- withNept' :: Text -> Maybe Text -> Maybe Text -> [Parameter] -> [(Text, Text)] -> [Text] -> (NeptuneSession -> Experiment -> IO a) -> IO a
- initNept :: HasCallStack => Text -> IO NeptuneSession
- teardownNept :: NeptuneSession -> Experiment -> Maybe (ExperimentState, Text) -> IO ()
Documentation
Experiment's hyper-parameter. When creating an experiment, you could specify parameters to present in the web console.
Constructors
| ExperimentParamS Text Text | |
| ExperimentParamD Text Double |
Arguments
| :: HasCallStack | |
| => NeptuneSession | Session |
| -> Maybe Text | Optional name (automatically assigned if Nothing) |
| -> Maybe Text | Optional description |
| -> [Parameter] | hyper-parameters |
| -> [(Text, Text)] | properties |
| -> [Text] | tags |
| -> IO Experiment |
Create an experiment
Arguments
| :: (HasCallStack, NeptDataType a) | |
| => Experiment | experiment |
| -> Text | key |
| -> a | value |
| -> IO () |
Log a key-value pair
Arguments
| :: Text | <namespace>/<project_name> |
| -> (NeptuneSession -> Experiment -> IO a) | action |
| -> IO a |
Run an action within a neptune session and a new experiment
Arguments
| :: Text | <namespace>/<project_name> |
| -> Maybe Text | Optional name of the experiment (automatically assigned if Nothing) |
| -> Maybe Text | Optional description of the experiment |
| -> [Parameter] | experiment hyper-parameters |
| -> [(Text, Text)] | experiment properties |
| -> [Text] | experiment tags |
| -> (NeptuneSession -> Experiment -> IO a) | action |
| -> IO a |
Run an action within a neptune session and a new experiment
Arguments
| :: HasCallStack | |
| => Text | <namespace>/<project_name> |
| -> IO NeptuneSession |
Initialize a neptune session
Arguments
| :: NeptuneSession | session |
| -> Experiment | experiment |
| -> Maybe (ExperimentState, Text) | completion state & message |
| -> IO () |
Teardown a neptune session