-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
160 lines (97 loc) · 6.95 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
---
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://github.com/davidycliao/flaiR)
[](https://github.com/davidycliao/flaiR/pkgs/container/flair-rstudio)
[](https://codecov.io/gh/davidycliao/flaiR)
[](https://www.codefactor.io/repository/github/davidycliao/flair)
<!-- [](https://github.com/davidycliao/flaiR/actions/workflows/docker-publish.yml) -->
<!-- <!--  -->
<!-- [](https://github.com/davidycliao/flaiR) -->
<!-- [](https://github.com/davidycliao/flaiR/pkgs/container/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)
# reticulate::py_install("flair")
# system(paste(reticulate::py_config()$python, "-m pip install flair"))
```
```{r include=FALSE}
# remotes::install_github("prodriguezsosa/conText", force = TRUE)
# remotes::install_github("tidyverse/tidytemplate", force = TRUE)
```
<div style="text-align: justify">
**flaiR** is an R package that provides convenient access to [flairNLP/flair](https://github.com/flairNLP/flair), a powerful Python-based NLP toolkit developed by Humboldt University of Berlin. **flaiR** package is maintained by [Yen-Chieh Liao](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) at UCD.
Through **flaiR**, R users can easily utilize and combine various word embeddings, train deep learning models, and fine-tune the latest transformer models from Hugging Face, bridging advanced NLP techniques with popular quantitative text analysis toolkits like quanteda in the R environment.
<!-- Our team trains and fine-tunes the models with Flair in [our projects](). -->
</div>
<br>
## Some Useful Cases
- [Working Various Embedding Framework in R](https://davidycliao.github.io/flaiR/articles/tutorial.html#embedding)
- [Beyond the 'à la carte' Embeddings Regression](https://davidycliao.github.io/flaiR/articles/tutorial.html#extending-contexts-embedding-regression)
- [Finetune Transformers in R](https://davidycliao.github.io/flaiR/articles/tutorial.html#finetune-transformers)
For more detailed tutorial instructions, please visit [Flair NLP and flaiR for Social Science](https://davidycliao.github.io/flaiR/articles/tutorial.html#introduction).
<br>
## Installation via <u>__`GitHub`__</u>
<div style="text-align: justify">
__Required Softwares__
- Python >= 3.10
- R >= 4.2.0
- Rstudio
__Operation Systems__
| OS | R Versions | Python Version |
|---------|----------------------------|----------------|
| Mac | 4.3.2, 4.2.0, ~~4.2.1~~* | 3.10.x, 3.9 |
| Windows | 4.0.5, Latest | 3.10.x, 3.9 |
| Ubuntu | 4.3.2, 4.2.0, 4.2.1 | 3.10.x, 3.9 |
*: _On R 4.2.1, particularly when using the Matrix package on ARM 64 architecture Macs (M1/M2), compatibility issues with gfortran may occur. It's recommended to avoid this combination._
<br>
```{r echo=TRUE, eval=FALSE}
install.packages("remotes")
remotes::install_github("davidycliao/flaiR", force = TRUE)
```
```{r echo=TRUE, eval=FALSE}
library(flaiR)
```
```r
#> flaiR: An R Wrapper for Accessing Flair NLP 0.13.1
```
<br>
## Installation with Docker
__Intel/AMD Processors:__
```r
# Pull image
docker pull ghcr.io/davidycliao/flair-rstudio:latest
# Run container
docker run -d -p 8787:8787 --user root --name flair-rstudio ghcr.io/davidycliao/flair-rstudio:latest
```
__Apple Silicon (M1/M2 Mac):__
```r
# Pull image
docker pull --platform linux/amd64 ghcr.io/davidycliao/flair-rstudio:latest
# Run container
docker run -d -p 8787:8787 --platform linux/amd64 --user root --name flair-rstudio ghcr.io/davidycliao/flair-rstudio:latest
```
After running these commands in terminal (or powershell), open your browser and navigate to [`http://localhost:8787`](http://localhost:8787) to access RStudio.
For detailed installation instructions, please visit [Quick Start Guide](https://davidycliao.github.io/flaiR/articles/quickstart.html#flair-installation).
</div>
<br>
## 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>