Skip to content

Commit

Permalink
Typo Fixing and Reformulation
Browse files Browse the repository at this point in the history
- fixes a type
- rewrites passages for better readability
  • Loading branch information
TimoImhof committed Nov 7, 2023
1 parent 60de6c9 commit 6786cb7
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions back_comp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,25 @@

## Motivation

This directory contains a set of tests that can be run to ensure newly introduced changes or performed refactorings don't break the existing functionalities.
We assume that the changes are developed on a separate branch, e.g., dev`, checked out from the main branch, `main`.
This directory contains a set of tests that can be run to ensure that newly introduced changes or refactorings do not break existing functionalities. These tests enable the verification of model output consistency between two branches, typically `dev` and `main`.

The script performs a forward pass for each supported model and compares if the outputs differ on `main` and `dev` or is identical.
The script performs a forward pass for each supported model and compares the outputs between the `main` and `dev` branches to identify any differences.

## Requirements
For executing these tests, certain requirements must be met:
- The ability to execute bash scripts (built-in under Linux/macOS; for Windows, we refer to using third-party software, such as [GNU](https://www.gnu.org/software/bash/))
- Git as a version control system to be able to checkout branches
- The ability to checkout to the desired branch; if the branch is, e.g., from another fork you may need to add the repository as a remote (see [here](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories) for instructions)
- A virtual environment with Python to modify the package version installed of `adapters`

To execute these tests, you must meet the following requirements:

- Ability to run bash scripts (in-built on Linux/macOS; for Windows, consider using third-party software like [GNU Bash](https://www.gnu.org/software/bash/)).
- Git as the version control system to switch between branches.
- The ability to check out the desired branch. If the branch is from another fork, you may need to add the repository as a remote. Refer to [GitHub's instructions](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories) for details.
- A Python virtual environment to modify the installed package version of `adapters`.

## Procedure

1. Determine a directory to save the model output produced by the test and save the path to the variable `SaveDir` in the shell script compare.sh
2. Select the branch you want to compare to `main` and save it to the variable `Branch`
3. In your command line, navigate to the `back_comp` dir and execute the script by typing `sh compare.sh`
To perform the compatibility tests, follow these steps:

1. Determine a directory where you want to save the model output generated by the tests. Save this directory path to the variable `SaveDir` in the shell script `compare.sh`.
2. Select the branch you want to compare with `main` and save its name to the variable `Branch`.
3. In your command line, navigate to the `back_comp` directory and execute the script by running `sh compare.sh`.

The results are visualized in the command line.
The results will be displayed in the command line for visualization.

0 comments on commit 6786cb7

Please sign in to comment.