Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rickyota authored Mar 12, 2024
1 parent 5a69340 commit 9528620
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ $ genoboost train \

- [v1.0.8](https://github.com/rickyota/genoboost/releases/tag/v1.0.8) (Nov 25, 2023)
- Initial version.
- Tested on Rocky Linux 8.9 and MacOS 14.3.1.


## <a name="introduction"></a>Introduction
Expand All @@ -76,12 +77,12 @@ For now, the input genotype format is allowed for plink1 or plink2 only.

### <a name="install"></a>Installation

Using arm architecture including Macbook M1, M2 chip will slow down due to unavailability of SIMD.
Using arm architecture, including Macbook M1 and M2 chips, will stop or slow down the software due to the unavailability of SIMD.
I plan to deal with it in the future.

#### <a name="install-plink1"></a>Plink1 Input

If you want to input plink1, download a program for your computer from [here][release].
If you want to input plink1, download a compiled program for Linux (tested on Rocky Linux<=8.9), macOS (tested on <=14.3.1), and Windows (not tested) from [here][release]. This should take less than 1 minute.

#### <a name="install-plink2"></a>Plink2 Input

Expand Down Expand Up @@ -131,6 +132,8 @@ $ ./genoboost train \
--seed 55
```

This test code should take less than 2 minutes.

#### <a name="train-train-only"></a>Without Validation

If you want to treat all samples as a training dataset, use `--train-only` option. GenoBoost produces SNV weights each for learning rate. Use `--iter-snv` or `--iter` to control the maximum number of SNVs or iterations for training.
Expand Down

0 comments on commit 9528620

Please sign in to comment.