Skip to content

Commit 908fa47

Browse files
authored
MRG: #642 from vocalpy/add-version-1.0-announcement-to-README
DOC: Add version 1.0 announcement to README [skip ci]
2 parents 792ccd6 + 45c21b2 commit 908fa47

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
[![Build Status](https://github.com/vocalpy/vak/actions/workflows/ci-linux.yml/badge.svg)](https://github.com/vocalpy/vak/actions/workflows/ci-linux.yml/badge.svg)
1717
[![codecov](https://codecov.io/gh/vocalpy/vak/branch/main/graph/badge.svg?token=9Y4XXB2ELA)](https://codecov.io/gh/vocalpy/vak)
1818

19+
<h3>🚧 vak version 1.0.0 is in development! 🚧 📣 Test out the alpha release: <code>pip install vak==1.0.0a1</code>. 📣 For more info, please see <a href="https://forum.vocalpy.org/t/vak-1-0-0a1-released/55"> this forum post<a>.</h3>
20+
21+
1922
`vak` is a Python framework for neural network models,
2023
designed for researchers studying animal acoustic communication and bioacoustics.
2124
Many people will be familiar with work in this area on
@@ -67,7 +70,7 @@ Notice that for `conda` you specify two channels,
6770
and that the `pytorch` channel should come first,
6871
so it takes priority when installing the dependencies `pytorch` and `torchvision`.
6972

70-
For more details, please see:
73+
For more details, please see:
7174
https://vak.readthedocs.io/en/latest/get_started/installation.html
7275

7376
We test `vak` on Ubuntu and MacOS. We have run on Windows and
@@ -87,9 +90,9 @@ https://vak.readthedocs.io/en/latest/get_started/autoannotate.html
8790

8891
#### How can I use my data with `vak`?
8992

90-
Please see the How-To Guides in the documentation here:
93+
Please see the How-To Guides in the documentation here:
9194
https://vak.readthedocs.io/en/latest/howto/index.html
92-
faq.html#faq
95+
9396
### Support / Contributing
9497

9598
For help, please begin by checking out the Frequently Asked Questions:

0 commit comments

Comments
 (0)