Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: upadte README.md #281

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ knitr::opts_chunk$set(
<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. The R 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.
**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 functionality with popular quantitative text analysis toolkits like quanteda in the R environment.
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](). -->
Expand All @@ -57,6 +57,20 @@ Through **flaiR**, R users can easily utilize and combine various word embedding
<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#embedding)

- [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/quickstart.html#flair-installation).

<br>


## Installation via <u>__`GitHub`__</u>


Expand Down
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Image](https://img.shields.io/badge/Docker-ghcr.io-blue?logo=docker)](https://gi

**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. The
R package is maintained by [Yen-Chieh
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
Expand All @@ -36,16 +36,33 @@ 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
functionality with popular quantitative text analysis toolkits like
quanteda in the R environment.
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#embedding)

- [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/quickstart.html#flair-installation).

<br>

## Installation via <u>**`GitHub`**</u>

<div style="text-align: justify">
Expand Down
Loading