-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
98 lines (62 loc) · 5.03 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
---
output: github_document
---
## <u>`flairR`</u>: An R Wrapper for Accessing Flair NLP Library <img src="man/figures/logo.png" align="right" width="180"/>
[](https://github.com/davidycliao/flaiR/actions/workflows/r_macos.yml)
[](https://github.com/davidycliao/flaiR/actions/workflows/r_ubuntu.yaml)
[](https://github.com/davidycliao/flaiR/actions/workflows/r_window.yml)
[](https://github.com/davidycliao/flaiR/actions/workflows/r.yml)
[](https://github.com/davidycliao/flaiR/actions/workflows/R-CMD-check.yml)
[](https://codecov.io/gh/davidycliao/flaiR)
[](https://www.codefactor.io/repository/github/davidycliao/flair)
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
```{r include=FALSE}
library(reticulate)
library(flaiR)
reticulate::py_install("flair")
system(paste(reticulate::py_config()$python, "-m pip install flair"))
# options(repos = c(CRAN = "https://cloud.r-project.org/"))
# install.packages("remotes")
# remotes::install_github("tidyverse/tidytemplate", force = TRUE)
```
<div style="text-align: justify">
__flaiR__ is an R package for accessing the [flairNLP/flair](flairNLP/flair) Python library, maintained by [Yen-ChiehLiao](https://davidycliao.github.io) ([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>
<br>
## Installation via <u>__`GitHub`__</u>
```{r echo=TRUE, eval=FALSE}
install.packages("remotes")
remotes::install_github("davidycliao/flaiR", force = TRUE)
```
```{r}
library(flaiR)
```
<br>
## Requirements
<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.
| OS | R Versions | Python Version |
|---------|----------------------------|----------------|
| Mac | 4.3.2, 4.2.0, ~~4.2.1~~* | 3.10.x |
| Mac | Latest | 3.9 |
| Windows | 4.0.5 | 3.10.x |
| Windows | Latest | 3.9 |
| Ubuntu | 4.3.2, 4.2.0, 4.2.1 | 3.10.x |
| Ubuntu | Latest | 3.9 |
*: _On R 4.2.1, especially on Mac M1/M2, compatibility issues with `gfortran` may occur._
<br>
</div>
## Contribution and Open Source
<div style="text-align: justify">
R developers who want to contribute to `flaiR` are welcome – flaiR is an open source project. We warmly invite R users who share similar interests to join in contributing to this package. Please feel free to shoot me an email us to collaborate on the task. Contributions – whether they be comments, code suggestions, tutorial examples, or forking the repository – are greatly appreciated. Please note that the `flaiR` is released with the [Contributor Code of Conduct](https://github.com/davidycliao/flaiR/blob/master/CONDUCT.md). By contributing to this project, you agree to abide by its terms.
The primary communication channel for R users can be found [here](https://github.com/davidycliao/flaiR/discussions). Please feel free to share your insights on the [Discussion](https://github.com/davidycliao/flaiR/discussions) page and report any issues related to the R interface in the [Issue](https://github.com/davidycliao/flaiR/issues) section. If the issue pertains to the actual implementation of Flair in Python, please submit a pull request to the offical [flair NLP](https://github.com/flairnlp/flair).
</div>
<br>