Skip to content

Commit

Permalink
Merge branch 'v1.1.0' into 'master'
Browse files Browse the repository at this point in the history
Bump version

See merge request algorithm/remora!129
  • Loading branch information
marcus1487 committed May 18, 2022
2 parents 94915a5 + 6bf392e commit eb6a6ae
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
11 changes: 10 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ Pre-trained Models
Pre-trained models are included in the Remora repository.
To see the selection of models included in the current installation run ``remora model list_pretrained``.

Models my be run from `Bonito <https://github.com/nanoporetech/bonito>`_ or `Megalodon <https://github.com/nanoporetech/megalodon>`_.
See documentation in these repositories for applying Remora models.

More advanced research models may be supplied via `Rerio <https://github.com/nanoporetech/rerio>`_.

Python API
----------

Expand Down Expand Up @@ -143,6 +148,10 @@ The following command performs this task in Remora.
The resulting ``remora_train_chunks.npz`` file can then be used to train a Remora model.

Additionally, ``remora dataset prepare`` can now accpet a pickle containing ``RemoraRead`` objects.
This allows users more flexibility to prepare reads for custom data preparation.
Note that ``RemoraRead`` pickle files can grow quite large.

Model Training
--------------

Expand All @@ -156,7 +165,7 @@ For example a model can be trained with the following command.
remora_train_chunks.npz \
--model remora/models/ConvLSTM_w_ref.py \
--device 0 \
--size 124 \
--size 96 \
--epochs 100 \
--early-stopping 10 \
--scheduler StepLR \
Expand Down
2 changes: 1 addition & 1 deletion src/remora/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "1.0.0"
__version__ = "1.1.0"


class RemoraError(Exception):
Expand Down

0 comments on commit eb6a6ae

Please sign in to comment.