diff --git a/README.Rmd b/README.Rmd index 6ddccbc0..d9fdf084 100644 --- a/README.Rmd +++ b/README.Rmd @@ -35,7 +35,7 @@ system(paste(reticulate::py_config()$python, "-m pip install flair"))
-__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]().
@@ -60,7 +60,7 @@ 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 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 | |---------|----------------------------|----------------| @@ -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._
diff --git a/README.md b/README.md index 00887cd9..221b481d 100644 --- a/README.md +++ b/README.md @@ -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](). @@ -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. @@ -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.*