Skip to content

Commit

Permalink
Fix typos and update variable names in README.md and pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
cyanxiao committed May 2, 2024
1 parent 0d28e97 commit f9b8b5f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Midori is a plugin-based orchestrator that allows researchers to run software en
- Randomizing the order of the trials.
- Switching between different treatments.
- ...
- **What is an orchestrator?** Mitori is meant to be a local tool that manipulates the remote cluster to run the experiments using SSH. In this way, the overhead of the experiment on the remote cluster is minimized.
- **What is an orchestrator?** Midori is meant to be a local tool that manipulates the remote cluster to run the experiments using SSH. In this way, the overhead of the experiment on the remote cluster is minimized.

<div align="center">
<img src="./illustrations/communication.png" alt="Midori as an orchestrator" width="50%">
Expand Down Expand Up @@ -64,7 +64,7 @@ The `subject_path` should be a git repository that contains branches named `oran

### Parameters

- `hostname`, `username`, `password`: Mitori needs these parameters to connect to the remote node via SSH.
- `hostname`, `username`, `password`: Midori needs these parameters to connect to the remote node via SSH.
- `repetitions`: The number of repetitions for the experiment.
- `before_trial_cooling_time`: The cooling time before each trial, in seconds.
- `trial_timespan`: The time span of each trial, in seconds.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "midori"
version = "1.0.0"
version = "1.0.1"
description = "🍃 streamline remote software engineering experiments"
authors = ["Xingwen Xiao <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit f9b8b5f

Please sign in to comment.