View Source ReadConfig (ExperimentRunner v0.1.0)

Link to this section Summary

Functions

Simple procedure for cloning Git repository.

Download dataset from the specified URL

User-friendly preprocessing of Yaml file.

Parse Yaml file.

Main entrypoint for running experiment scripts.

Link to this section Functions

Simple procedure for cloning Git repository.

parameters

Parameters

  • repo: Git repository

examples

Examples

iex> ReadConfig.read_yaml("nia-experiment.yml")
"TODO"
Link to this function

download_dataset(dataset, path)

View Source

Download dataset from the specified URL

parameters

Parameters

  • dataset: Dataset URL.
  • path: Folder where downloaded dataset is stored.

examples

Examples

iex> ReadConfig.download_dataset("https://raw.githubusercontent.com/lukapecnik/NiaClass/master/examples/example_files/dataset.csv", "datasets/")
"TODO"
Link to this function

preprocess_yaml(content)

View Source

User-friendly preprocessing of Yaml file.

parameters

Parameters

  • content: Parsed Yaml file content.

examples

Examples

iex> ReadConfig.read_yaml("nia-experiment.yml")
"TODO"

Parse Yaml file.

parameters

Parameters

  • file: Filename where configuration is stored.

examples

Examples

iex> ReadConfig.read_yaml("nia-experiment.yml")
"TODO"
Link to this function

run_experiment_script(name, language, script)

View Source

Main entrypoint for running experiment scripts.

parameters

Parameters

  • language: atom (programming language)
  • script: name of script to be run

examples

Examples

iex> ReadConfig.read_yaml("nia-experiment.yml")
"TODO"