Skip to content

Commit

Permalink
UPDATE README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
davidycliao committed Sep 23, 2024
1 parent bb47d63 commit c2644f3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ system(paste(reticulate::py_config()$python, "-m pip install flair"))

<div style="text-align: justify">

__flaiR__ is an R package for accessing the [flairNLP/flair](flairNLP/flair) Python library, maintained by [Yen-Chieh (David ) Liao](https://davidycliao.github.io) ([CAIG, University of Birmingham]()) and [Stefan Müller](https://muellerstefan.net) from [Next Generation Energy Systems](https://www.nexsys-energy.ie) and [Text and Policy Research Group](https://text-and-policy.com) in UCD. flaiR provides convenient access to the main functionalities of flairNLP for training word embedding-based deep learning models and fine-tune state-of-the-art transformers hosted on Hugging Face. Our team trains and fine-tunes the models with Flair in [our projects]().
__flaiR__ is an R package for accessing the [flairNLP/flair](flairNLP/flair) Python library, maintained by [Yen-ChiehLiao](https://davidycliao.github.io) ([CAIG, University of Birmingham](https://www.birmingham.ac.uk/research/centres-institutes/centre-for-artificial-intelligence-in-government)) and [Stefan Müller](https://muellerstefan.net) from [Next Generation Energy Systems](https://www.nexsys-energy.ie) and [Text and Policy Research Group](https://text-and-policy.com) in UCD. flaiR provides convenient access to the main functionalities of flairNLP for training word embedding-based deep learning models and fine-tune state-of-the-art transformers hosted on Hugging Face. Our team trains and fine-tunes the models with Flair in [our projects]().

</div>

Expand All @@ -60,7 +60,7 @@ library(flaiR)

<div style="text-align: justify">

__flaiR__ runs the Flair NLP backend in Python, thus requiring Python installation. We have extensively tested flaiR using CI/CD with GitHub Actions, conducting integration tests across various operating systems. These tests includes integration between R versions~~4.2.1~~, 4.3.2, and 4.2.0, along with Python 3.9 and 3.10.x. Additionally, the testing includes environments with PyTorch, Flair NLP, and their dependencies in both R and Python. For stable usage, we strongly recommend installing these specific versions.
__flaiR__ runs the Flair NLP backend in Python, thus requiring Python installation. We have extensively tested flaiR using CI/CD with GitHub Actions, conducting integration tests across various operating systems. These tests includes integration between R versions ~~4.2.1~~, 4.3.2, and 4.2.0, along with Python 3.9 and 3.10.x. Additionally, the testing includes environments with PyTorch, Flair NLP, and their dependencies in both R and Python. For stable usage, we strongly recommend installing these specific versions.

| OS | R Versions | Python Version |
|---------|----------------------------|----------------|
Expand All @@ -71,7 +71,7 @@ __flaiR__ runs the Flair NLP backend in Python, thus requiring Python installati
| Ubuntu | 4.3.2, 4.2.0, 4.2.1 | 3.10.x |
| Ubuntu | Latest | 3.9 |

*: _On R 4.2.1, especially on M1/M2, compatibility issues with `gfortran` may arise._
*: _On R 4.2.1, especially on Mac M1/M2, compatibility issues with `gfortran` may occur._

<br>

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@

**flaiR** is an R package for accessing the
[flairNLP/flair](flairNLP/flair) Python library, maintained by
[Yen-Chieh (David ) Liao](https://davidycliao.github.io) ([CAIG,
University of Birmingham]()) and [Stefan
Müller](https://muellerstefan.net) from [Next Generation Energy
Systems](https://www.nexsys-energy.ie) and [Text and Policy Research
Group](https://text-and-policy.com) in UCD. flaiR provides convenient
access to the main functionalities of flairNLP for training word
embedding-based deep learning models and fine-tune state-of-the-art
[Yen-ChiehLiao](https://davidycliao.github.io) ([CAIG, University of
Birmingham](https://www.birmingham.ac.uk/research/centres-institutes/centre-for-artificial-intelligence-in-government))
and [Stefan Müller](https://muellerstefan.net) from [Next Generation
Energy Systems](https://www.nexsys-energy.ie) and [Text and Policy
Research Group](https://text-and-policy.com) in UCD. flaiR provides
convenient access to the main functionalities of flairNLP for training
word embedding-based deep learning models and fine-tune state-of-the-art
transformers hosted on Hugging Face. Our team trains and fine-tunes the
models with Flair in [our projects]().

Expand Down Expand Up @@ -49,8 +49,8 @@ library(flaiR)
**flaiR** runs the Flair NLP backend in Python, thus requiring Python
installation. We have extensively tested flaiR using CI/CD with GitHub
Actions, conducting integration tests across various operating systems.
These tests includes integration between R versions~~4.2.1~~, 4.3.2, and
4.2.0, along with Python 3.9 and 3.10.x. Additionally, the testing
These tests includes integration between R versions ~~4.2.1~~, 4.3.2,
and 4.2.0, along with Python 3.9 and 3.10.x. Additionally, the testing
includes environments with PyTorch, Flair NLP, and their dependencies in
both R and Python. For stable usage, we strongly recommend installing
these specific versions.
Expand All @@ -64,8 +64,8 @@ these specific versions.
| Ubuntu | 4.3.2, 4.2.0, 4.2.1 | 3.10.x |
| Ubuntu | Latest | 3.9 |

\*: *On R 4.2.1, especially on M1/M2, compatibility issues with gfortran
may arise.*
\*: *On R 4.2.1, especially on Mac M1/M2, compatibility issues with
`gfortran` may occur.*

<br>

Expand Down

0 comments on commit c2644f3

Please sign in to comment.