1606099841
What is Reflect Finance (RFI) | What is Reflect Finance token | What is RFI token
RFI is an innovative Ethereum token that re-imagines the concept of DeFI yield generation.
At its core, RFI charges a 1% transaction fee and re-distributes that fee to existing RFI holders instantly and automatically at the time of each transaction.
Unique features of the RFI smart contract allow certain addresses like the Uniswap pool or exchange wallets to be blocked from earning fees.
Because of this, 100% of the fees generated go to holders of the token. The percentage of fees you earn is calculated by the percentage of RFI that you own among holders. This generates a much higher yield than would otherwise be possible.
There is no team or central party that has to award the fees. There is no interface to claim the fees. No action needs to be taken on your part other than to hold RFI in a wallet you control.
The Problem
The overwhelming majority of DeFi projects require trust in a central party and interaction with complex, buggy, and easily hacked contracts.
Rewards for interacting with these contracts often come from the minting of new tokens, necessitating confusing (and usually centralized) economic mechanisms that attempt to give the underlying reward token some value.
Developers who design and implement these economic reward mechanisms typically have no expertise in economics.
This places an enormous amount of risk on individuals that choose to interact with DeFi smart contracts. For simplicity, lets break down some of the different kinds of risk accepted by your average DeFi participant:
- Price and Market risk: Price movements of a specific token or the market as a whole that negatively affect the token holder.
- **Trust related risk: **Individuals or teams behind a project performing actions that negatively affect the token holder (rug pulls, large token unlocks and dumps, etc…)
- Security risk: Vulnerabilities in smart contracts or interfaces that the token holder interacts with.
- Economic Design risk: Tokenomics that are poorly designed and unsustainable.
The Solution
RFI is uniquely designed to address these problems and reduce the aforementioned risks. Lets look at how RFI reduces each of the risks mentioned in the previous section:
- Price and Market risk: These risks come with any free market. Anyone claiming to guarantee a specific yield or eliminate this risk are lying to you.
- Trust related risk: No ICO, No Pre-sale, No Fundraising. No vaults or treasuries. No community funds that could be mismanaged. No website or interface is required for the token to function. As long as Ethereum exists, RFI fees will be generated and distributed with each transaction.
- Security risk: Because fee generation AND distribution is baked into the core smart contract, security risk is greatly reduced. No external contracts or interfaces need to be interacted with in any way.
- Economic Design risk: RFI has a fixed cap of 10M. The yield comes from transfer fees instead of newly minted tokens. As you earn fees, the percentage of the total supply you own is increasing. Earning network fees is an established and tested method of earning yield.
The Elephant in the Room — Opportunity Cost
Beyond the extreme risks involved with DeFi, individuals must stake or park their tokens in a contract to earn a yield. There is a massive opportunity cost associated with this as participants could be using their locked tokens to earn a yield some other way but are unable to seize that opportunity while the tokens are locked.
Lets look at how RFI addresses opportunity cost.
RFI fees are awarded automatically and do not require any transaction to be executed by the holder in order to earn fees. This allows RFI to be used in any other smart contract in addition to earning yield from the transaction fees.
To facilitate this, the RFI smart contract exposes some new methods that allow other smart contracts to easily determine the fees earned by each address for any period of time even when funds are pooled together. This is a huge leap in DeFi that enables the direct staking of RFI and double yield generation.
For example, you could lend your RFI on a third party app and earn a yield from that while still earning fees from RFI transfers. The lending contract could use RFI’s new methods to easily determine the fees earned on the amount you provided during your interaction with the lending contract.
By reducing friction and eliminating the burden of contract interaction to earn a yield, RFI is truly a step forward in DeFi.
A Fair and Free Market
The RFI smart contract is complete at launch. There was no ICO, no pre-sale, and no fundraising of any kind. There are no more features to add. There is no individual or team to be relied upon to give RFI any value.
95% of the total fixed supply of 10M tokens goes into the initial Uniswap liquidity pool.
5% of the total fixed supply of 10M tokens goes to a 15 day yield farming program where they can be farmed by holders of Flow Protocol.
Yield Farming with Flow Protocol
There are few truly decentralized cryptocurrencies in this space. Flow Protocol https://flowprotocol.io is one of those projects which is also backed up with secure, formally audited contracts.
Flow Protocol addresses a long standing economic problem called the Cantillon Effect, where specific parties benefit from monetary inflation before others. Flow Protocol combats the Cantillon Effect with non-dilutive transactionless inflation, automatically increasing the balance of each holder daily without the need for a single transaction. This method allows for the token to be applied to modern DeFi use cases (like yield farming RFI) without diluting the token holders.
As a nod to the innovation and decentralization of Flow Protocol, 5% of the RFI supply can be earned over 15 days by staking FLOW/ETH LP tokens from Uniswap.
How and Where to Buy RFI?
RFI has been listed on a number of crypto exchanges, unlike other main cryptocurrencies, it cannot be directly purchased with fiats money. However, You can still easily buy this coin by first buying Bitcoin, ETH, USDT from any large exchanges and then transfer to the exchange that offers to trade this coin, in this guide article we will walk you through in detail the steps to buy RFI
You will have to first buy one of the major cryptocurrencies, usually either Bitcoin (BTC), Ethereum (ETH), Tether (USDT)…
We will use Binance Exchange here as it is one of the largest crypto exchanges that accept fiat deposits.
Binance is a popular cryptocurrency exchange which was started in China but then moved their headquarters to the crypto-friendly Island of Malta in the EU. Binance is popular for its crypto to crypto exchange services. Binance exploded onto the scene in the mania of 2017 and has since gone on to become the top crypto exchange in the world.
Once you finished the KYC process. You will be asked to add a payment method. Here you can either choose to provide a credit/debit card or use a bank transfer, and buy one of the major cryptocurrencies, usually either Bitcoin (BTC), Ethereum (ETH), Tether (USDT)
Step by Step Guide : What is Binance | How to Create an account on Binance (Updated 2021)
Next step - Transfer your cryptos to an Altcoin Exchange
Since RFI is an altcoin we need to transfer our coins to an exchange that RFI can be traded. Below is a list of exchanges that offers to trade RFI in various market pairs, head to their websites and register for an account.
Once finished you will then need to make a BTC/ETH/USDT deposit to the exchange from Binance depending on the available market pairs. After the deposit is confirmed you may then purchase RFI from the exchange.
Exchange: Uniswap (V2) and 1inch Exchange
Apart from the exchange(s) above, there are a few popular crypto exchanges where they have decent daily trading volumes and a huge user base. This will ensure you will be able to sell your coins at any time and the fees will usually be lower. It is suggested that you also register on these exchanges since once RFI gets listed there it will attract a large amount of trading volumes from the users there, that means you will be having some great trading opportunities!
Top exchanges for token-coin trading. Follow instructions and make unlimited money
☞ Binance ☞ Bittrex ☞ Poloniex ☞ Bitfinex ☞ Huobi ☞ MXC ☞ ProBIT ☞ Gate.io ☞ Coinbase
Find more information RFI
☞ Website
☞ Explorer
☞ Source Code
☞ Social Channel
☞ Message Board
☞ Coinmarketcap
Would you like to earn TOKEN right now! ☞ CLICK HERE
I hope this post will help you. If you liked this, please sharing it with others. Thank you!
#blockchain #bitcoin #cryptocurrency #reflect.finance #rfi
What is GEEK
Buddha Community
1606099841
What is Reflect Finance (RFI) | What is Reflect Finance token | What is RFI token
RFI is an innovative Ethereum token that re-imagines the concept of DeFI yield generation.
At its core, RFI charges a 1% transaction fee and re-distributes that fee to existing RFI holders instantly and automatically at the time of each transaction.
Unique features of the RFI smart contract allow certain addresses like the Uniswap pool or exchange wallets to be blocked from earning fees.
Because of this, 100% of the fees generated go to holders of the token. The percentage of fees you earn is calculated by the percentage of RFI that you own among holders. This generates a much higher yield than would otherwise be possible.
There is no team or central party that has to award the fees. There is no interface to claim the fees. No action needs to be taken on your part other than to hold RFI in a wallet you control.
The Problem
The overwhelming majority of DeFi projects require trust in a central party and interaction with complex, buggy, and easily hacked contracts.
Rewards for interacting with these contracts often come from the minting of new tokens, necessitating confusing (and usually centralized) economic mechanisms that attempt to give the underlying reward token some value.
Developers who design and implement these economic reward mechanisms typically have no expertise in economics.
This places an enormous amount of risk on individuals that choose to interact with DeFi smart contracts. For simplicity, lets break down some of the different kinds of risk accepted by your average DeFi participant:
- Price and Market risk: Price movements of a specific token or the market as a whole that negatively affect the token holder.
- **Trust related risk: **Individuals or teams behind a project performing actions that negatively affect the token holder (rug pulls, large token unlocks and dumps, etc…)
- Security risk: Vulnerabilities in smart contracts or interfaces that the token holder interacts with.
- Economic Design risk: Tokenomics that are poorly designed and unsustainable.
The Solution
RFI is uniquely designed to address these problems and reduce the aforementioned risks. Lets look at how RFI reduces each of the risks mentioned in the previous section:
- Price and Market risk: These risks come with any free market. Anyone claiming to guarantee a specific yield or eliminate this risk are lying to you.
- Trust related risk: No ICO, No Pre-sale, No Fundraising. No vaults or treasuries. No community funds that could be mismanaged. No website or interface is required for the token to function. As long as Ethereum exists, RFI fees will be generated and distributed with each transaction.
- Security risk: Because fee generation AND distribution is baked into the core smart contract, security risk is greatly reduced. No external contracts or interfaces need to be interacted with in any way.
- Economic Design risk: RFI has a fixed cap of 10M. The yield comes from transfer fees instead of newly minted tokens. As you earn fees, the percentage of the total supply you own is increasing. Earning network fees is an established and tested method of earning yield.
The Elephant in the Room — Opportunity Cost
Beyond the extreme risks involved with DeFi, individuals must stake or park their tokens in a contract to earn a yield. There is a massive opportunity cost associated with this as participants could be using their locked tokens to earn a yield some other way but are unable to seize that opportunity while the tokens are locked.
Lets look at how RFI addresses opportunity cost.
RFI fees are awarded automatically and do not require any transaction to be executed by the holder in order to earn fees. This allows RFI to be used in any other smart contract in addition to earning yield from the transaction fees.
To facilitate this, the RFI smart contract exposes some new methods that allow other smart contracts to easily determine the fees earned by each address for any period of time even when funds are pooled together. This is a huge leap in DeFi that enables the direct staking of RFI and double yield generation.
For example, you could lend your RFI on a third party app and earn a yield from that while still earning fees from RFI transfers. The lending contract could use RFI’s new methods to easily determine the fees earned on the amount you provided during your interaction with the lending contract.
By reducing friction and eliminating the burden of contract interaction to earn a yield, RFI is truly a step forward in DeFi.
A Fair and Free Market
The RFI smart contract is complete at launch. There was no ICO, no pre-sale, and no fundraising of any kind. There are no more features to add. There is no individual or team to be relied upon to give RFI any value.
95% of the total fixed supply of 10M tokens goes into the initial Uniswap liquidity pool.
5% of the total fixed supply of 10M tokens goes to a 15 day yield farming program where they can be farmed by holders of Flow Protocol.
Yield Farming with Flow Protocol
There are few truly decentralized cryptocurrencies in this space. Flow Protocol https://flowprotocol.io is one of those projects which is also backed up with secure, formally audited contracts.
Flow Protocol addresses a long standing economic problem called the Cantillon Effect, where specific parties benefit from monetary inflation before others. Flow Protocol combats the Cantillon Effect with non-dilutive transactionless inflation, automatically increasing the balance of each holder daily without the need for a single transaction. This method allows for the token to be applied to modern DeFi use cases (like yield farming RFI) without diluting the token holders.
As a nod to the innovation and decentralization of Flow Protocol, 5% of the RFI supply can be earned over 15 days by staking FLOW/ETH LP tokens from Uniswap.
How and Where to Buy RFI?
RFI has been listed on a number of crypto exchanges, unlike other main cryptocurrencies, it cannot be directly purchased with fiats money. However, You can still easily buy this coin by first buying Bitcoin, ETH, USDT from any large exchanges and then transfer to the exchange that offers to trade this coin, in this guide article we will walk you through in detail the steps to buy RFI
You will have to first buy one of the major cryptocurrencies, usually either Bitcoin (BTC), Ethereum (ETH), Tether (USDT)…
We will use Binance Exchange here as it is one of the largest crypto exchanges that accept fiat deposits.
Binance is a popular cryptocurrency exchange which was started in China but then moved their headquarters to the crypto-friendly Island of Malta in the EU. Binance is popular for its crypto to crypto exchange services. Binance exploded onto the scene in the mania of 2017 and has since gone on to become the top crypto exchange in the world.
Once you finished the KYC process. You will be asked to add a payment method. Here you can either choose to provide a credit/debit card or use a bank transfer, and buy one of the major cryptocurrencies, usually either Bitcoin (BTC), Ethereum (ETH), Tether (USDT)
Step by Step Guide : What is Binance | How to Create an account on Binance (Updated 2021)
Next step - Transfer your cryptos to an Altcoin Exchange
Since RFI is an altcoin we need to transfer our coins to an exchange that RFI can be traded. Below is a list of exchanges that offers to trade RFI in various market pairs, head to their websites and register for an account.
Once finished you will then need to make a BTC/ETH/USDT deposit to the exchange from Binance depending on the available market pairs. After the deposit is confirmed you may then purchase RFI from the exchange.
Exchange: Uniswap (V2) and 1inch Exchange
Apart from the exchange(s) above, there are a few popular crypto exchanges where they have decent daily trading volumes and a huge user base. This will ensure you will be able to sell your coins at any time and the fees will usually be lower. It is suggested that you also register on these exchanges since once RFI gets listed there it will attract a large amount of trading volumes from the users there, that means you will be having some great trading opportunities!
Top exchanges for token-coin trading. Follow instructions and make unlimited money
☞ Binance ☞ Bittrex ☞ Poloniex ☞ Bitfinex ☞ Huobi ☞ MXC ☞ ProBIT ☞ Gate.io ☞ Coinbase
Find more information RFI
☞ Website
☞ Explorer
☞ Source Code
☞ Social Channel
☞ Message Board
☞ Coinmarketcap
Would you like to earn TOKEN right now! ☞ CLICK HERE
I hope this post will help you. If you liked this, please sharing it with others. Thank you!
#blockchain #bitcoin #cryptocurrency #reflect.finance #rfi
1624219980
How to Buy NFT Art Finance Token - The EASIEST METHOD! DO NOT MISS!!! JUST IN 4 MINUTES
NFT Art Finance is currently one of the most popular cryptocurrencies right now on the market, so in today’s video, I will be showing you guys how to easily buy NFT Art Finance on your phone using the Trust Wallet application.
📺 The video in this post was made by More LimSanity
The origin of the article: https://www.youtube.com/watch?v=sKE6Pc_w1IE
🔺 DISCLAIMER: The article is for information sharing. The content of this video is solely the opinions of the speaker who is not a licensed financial advisor or registered investment advisor. Not investment advice or legal advice.
Cryptocurrency trading is VERY risky. Make sure you understand these risks and that you are responsible for what you do with your money
🔥 If you’re a beginner. I believe the article below will be useful to you ☞ What You Should Know Before Investing in Cryptocurrency - For Beginner
⭐ ⭐ ⭐The project is of interest to the community. Join to Get free ‘GEEK coin’ (GEEKCASH coin)!
☞ **-----CLICK HERE-----**⭐ ⭐ ⭐
Thanks for visiting and watching! Please don’t forget to leave a like, comment and share!
#bitcoin #blockchain #nft art finance token #token #buy nft art finance #how to buy nft art finance token - the easiest method!
1624312800
SPORE FINANCE PREDICTION - WHAT IS SPORE FINANCE & SPORE FINANCE ANALYSIS - SPORE FINANCE
SPORE FINANCE PREDICTION - WHAT IS SPORE FINANCE & SPORE FINANCE ANALYSIS - SPORE FINANCE
In this video, I talk about spore finance coin and give my spore finance prediction. I talk about the latest spore finance analysis & spore finance crypto coin that recently has been hit pretty hard in the last 24 hours. I go over what is spore finance and how many holders are on this new crypto coin spore finance.
📺 The video in this post was made by Josh’s Finance
The origin of the article: https://www.youtube.com/watch?v=qbPQvdxCtEI
🔺 DISCLAIMER: The article is for information sharing. The content of this video is solely the opinions of the speaker who is not a licensed financial advisor or registered investment advisor. Not investment advice or legal advice.
Cryptocurrency trading is VERY risky. Make sure you understand these risks and that you are responsible for what you do with your money
🔥 If you’re a beginner. I believe the article below will be useful to you ☞ What You Should Know Before Investing in Cryptocurrency - For Beginner
⭐ ⭐ ⭐The project is of interest to the community. Join to Get free ‘GEEK coin’ (GEEKCASH coin)!
☞ **-----CLICK HERE-----**⭐ ⭐ ⭐
Thanks for visiting and watching! Please don’t forget to leave a like, comment and share!
#bitcoin #blockchain #spore finance #what is spore finance #spore finance prediction - what is spore finance & spore finance analysis - spore finance #spore finance prediction
1658068560
WordsCounted: A Ruby Natural Language Processor
WordsCounted
We are all in the gutter, but some of us are looking at the stars.
-- Oscar Wilde
WordsCounted is a Ruby NLP (natural language processor). WordsCounted lets you implement powerful tokensation strategies with a very flexible tokeniser class.
Features
- Out of the box, get the following data from any string or readable file, or URL:
- Token count and unique token count
- Token densities, frequencies, and lengths
- Char count and average chars per token
- The longest tokens and their lengths
- The most frequent tokens and their frequencies.
- A flexible way to exclude tokens from the tokeniser. You can pass a string, regexp, symbol, lambda, or an array of any combination of those types for powerful tokenisation strategies.
- Pass your own regexp rules to the tokeniser if you prefer. The default regexp filters special characters but keeps hyphens and apostrophes. It also plays nicely with diacritics (UTF and unicode characters): Bayrūt is treated as
["Bayrūt"]and not["Bayr", "ū", "t"], for example. - Opens and reads files. Pass in a file path or a url instead of a string.
Installation
Add this line to your application's Gemfile:
gem 'words_counted'
And then execute:
$ bundle
Or install it yourself as:
$ gem install words_counted
Usage
Pass in a string or a file path, and an optional filter and/or regexp.
counter = WordsCounted.count(
"We are all in the gutter, but some of us are looking at the stars."
)
# Using a file
counter = WordsCounted.from_file("path/or/url/to/my/file.txt")
.count and .from_file are convenience methods that take an input, tokenise it, and return an instance of WordsCounted::Counter initialized with the tokens. The WordsCounted::Tokeniser and WordsCounted::Counter classes can be used alone, however.
API
WordsCounted
WordsCounted.count(input, options = {})
Tokenises input and initializes a WordsCounted::Counter object with the resulting tokens.
counter = WordsCounted.count("Hello Beirut!")
Accepts two options: exclude and regexp. See Excluding tokens from the analyser and Passing in a custom regexp respectively.
WordsCounted.from_file(path, options = {})
Reads and tokenises a file, and initializes a WordsCounted::Counter object with the resulting tokens.
counter = WordsCounted.from_file("hello_beirut.txt")
Accepts the same options as .count.
Tokeniser
The tokeniser allows you to tokenise text in a variety of ways. You can pass in your own rules for tokenisation, and apply a powerful filter with any combination of rules as long as they can boil down into a lambda.
Out of the box the tokeniser includes only alpha chars. Hyphenated tokens and tokens with apostrophes are considered a single token.
#tokenise([pattern: TOKEN_REGEXP, exclude: nil])
tokeniser = WordsCounted::Tokeniser.new("Hello Beirut!").tokenise
# With `exclude`
tokeniser = WordsCounted::Tokeniser.new("Hello Beirut!").tokenise(exclude: "hello")
# With `pattern`
tokeniser = WordsCounted::Tokeniser.new("I <3 Beirut!").tokenise(pattern: /[a-z]/i)
See Excluding tokens from the analyser and Passing in a custom regexp for more information.
Counter
The WordsCounted::Counter class allows you to collect various statistics from an array of tokens.
#token_count
Returns the token count of a given string.
counter.token_count #=> 15
#token_frequency
Returns a sorted (unstable) two-dimensional array where each element is a token and its frequency. The array is sorted by frequency in descending order.
counter.token_frequency
[
["the", 2],
["are", 2],
["we", 1],
# ...
["all", 1]
]
#most_frequent_tokens
Returns a hash where each key-value pair is a token and its frequency.
counter.most_frequent_tokens
{ "are" => 2, "the" => 2 }
#token_lengths
Returns a sorted (unstable) two-dimentional array where each element contains a token and its length. The array is sorted by length in descending order.
counter.token_lengths
[
["looking", 7],
["gutter", 6],
["stars", 5],
# ...
["in", 2]
]
#longest_tokens
Returns a hash where each key-value pair is a token and its length.
counter.longest_tokens
{ "looking" => 7 }
#token_density([ precision: 2 ])
Returns a sorted (unstable) two-dimentional array where each element contains a token and its density as a float, rounded to a precision of two. The array is sorted by density in descending order. It accepts a precision argument, which must be a float.
counter.token_density
[
["are", 0.13],
["the", 0.13],
["but", 0.07 ],
# ...
["we", 0.07 ]
]
#char_count
Returns the char count of tokens.
counter.char_count #=> 76
#average_chars_per_token([ precision: 2 ])
Returns the average char count per token rounded to two decimal places. Accepts a precision argument which defaults to two. Precision must be a float.
counter.average_chars_per_token #=> 4
#uniq_token_count
Returns the number of unique tokens.
counter.uniq_token_count #=> 13
Excluding tokens from the tokeniser
You can exclude anything you want from the input by passing the exclude option. The exclude option accepts a variety of filters and is extremely flexible.
- A space-delimited string. The filter will normalise the string.
- A regular expression.
- A lambda.
- A symbol that names a predicate method. For example
:odd?. - An array of any combination of the above.
tokeniser =
WordsCounted::Tokeniser.new(
"Magnificent! That was magnificent, Trevor."
)
# Using a string
tokeniser.tokenise(exclude: "was magnificent")
# => ["that", "trevor"]
# Using a regular expression
tokeniser.tokenise(exclude: /trevor/)
# => ["magnificent", "that", "was", "magnificent"]
# Using a lambda
tokeniser.tokenise(exclude: ->(t) { t.length < 4 })
# => ["magnificent", "that", "magnificent", "trevor"]
# Using symbol
tokeniser = WordsCounted::Tokeniser.new("Hello! محمد")
tokeniser.tokenise(exclude: :ascii_only?)
# => ["محمد"]
# Using an array
tokeniser = WordsCounted::Tokeniser.new(
"Hello! اسماءنا هي محمد، كارولينا، سامي، وداني"
)
tokeniser.tokenise(
exclude: [:ascii_only?, /محمد/, ->(t) { t.length > 6}, "و"]
)
# => ["هي", "سامي", "وداني"]
Passing in a custom regexp
The default regexp accounts for letters, hyphenated tokens, and apostrophes. This means twenty-one is treated as one token. So is Mohamad's.
/[\p{Alpha}\-']+/
You can pass your own criteria as a Ruby regular expression to split your string as desired.
For example, if you wanted to include numbers, you can override the regular expression:
counter = WordsCounted.count("Numbers 1, 2, and 3", pattern: /[\p{Alnum}\-']+/)
counter.tokens
#=> ["numbers", "1", "2", "and", "3"]
Opening and reading files
Use the from_file method to open files. from_file accepts the same options as .count. The file path can be a URL.
counter = WordsCounted.from_file("url/or/path/to/file.text")
Gotchas
A hyphen used in leu of an em or en dash will form part of the token. This affects the tokeniser algorithm.
counter = WordsCounted.count("How do you do?-you are well, I see.")
counter.token_frequency
[
["do", 2],
["how", 1],
["you", 1],
["-you", 1], # WTF, mate!
["are", 1],
# ...
]
In this example -you and you are separate tokens. Also, the tokeniser does not include numbers by default. Remember that you can pass your own regular expression if the default behaviour does not fit your needs.
A note on case sensitivity
The program will normalise (downcase) all incoming strings for consistency and filters.
Roadmap
Ability to open URLs
def self.from_url
# open url and send string here after removing html
end
Are you using WordsCounted to do something interesting? Please tell me about it.
Demo
Visit this website for one example of what you can do with WordsCounted.
Contributors
See contributors.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Author: Abitdodgy
Source Code: https://github.com/abitdodgy/words_counted
License: MIT license
1659601560
Words Counted: A Ruby Natural Language Processor.
WordsCounted
We are all in the gutter, but some of us are looking at the stars.
-- Oscar Wilde
WordsCounted is a Ruby NLP (natural language processor). WordsCounted lets you implement powerful tokensation strategies with a very flexible tokeniser class.
Are you using WordsCounted to do something interesting? Please tell me about it.
Demo
Visit this website for one example of what you can do with WordsCounted.
Features
- Out of the box, get the following data from any string or readable file, or URL:
- Token count and unique token count
- Token densities, frequencies, and lengths
- Char count and average chars per token
- The longest tokens and their lengths
- The most frequent tokens and their frequencies.
- A flexible way to exclude tokens from the tokeniser. You can pass a string, regexp, symbol, lambda, or an array of any combination of those types for powerful tokenisation strategies.
- Pass your own regexp rules to the tokeniser if you prefer. The default regexp filters special characters but keeps hyphens and apostrophes. It also plays nicely with diacritics (UTF and unicode characters): Bayrūt is treated as
["Bayrūt"]and not["Bayr", "ū", "t"], for example. - Opens and reads files. Pass in a file path or a url instead of a string.
Installation
Add this line to your application's Gemfile:
gem 'words_counted'
And then execute:
$ bundle
Or install it yourself as:
$ gem install words_counted
Usage
Pass in a string or a file path, and an optional filter and/or regexp.
counter = WordsCounted.count(
"We are all in the gutter, but some of us are looking at the stars."
)
# Using a file
counter = WordsCounted.from_file("path/or/url/to/my/file.txt")
.count and .from_file are convenience methods that take an input, tokenise it, and return an instance of WordsCounted::Counter initialized with the tokens. The WordsCounted::Tokeniser and WordsCounted::Counter classes can be used alone, however.
API
WordsCounted
WordsCounted.count(input, options = {})
Tokenises input and initializes a WordsCounted::Counter object with the resulting tokens.
counter = WordsCounted.count("Hello Beirut!")
Accepts two options: exclude and regexp. See Excluding tokens from the analyser and Passing in a custom regexp respectively.
WordsCounted.from_file(path, options = {})
Reads and tokenises a file, and initializes a WordsCounted::Counter object with the resulting tokens.
counter = WordsCounted.from_file("hello_beirut.txt")
Accepts the same options as .count.
Tokeniser
The tokeniser allows you to tokenise text in a variety of ways. You can pass in your own rules for tokenisation, and apply a powerful filter with any combination of rules as long as they can boil down into a lambda.
Out of the box the tokeniser includes only alpha chars. Hyphenated tokens and tokens with apostrophes are considered a single token.
#tokenise([pattern: TOKEN_REGEXP, exclude: nil])
tokeniser = WordsCounted::Tokeniser.new("Hello Beirut!").tokenise
# With `exclude`
tokeniser = WordsCounted::Tokeniser.new("Hello Beirut!").tokenise(exclude: "hello")
# With `pattern`
tokeniser = WordsCounted::Tokeniser.new("I <3 Beirut!").tokenise(pattern: /[a-z]/i)
See Excluding tokens from the analyser and Passing in a custom regexp for more information.
Counter
The WordsCounted::Counter class allows you to collect various statistics from an array of tokens.
#token_count
Returns the token count of a given string.
counter.token_count #=> 15
#token_frequency
Returns a sorted (unstable) two-dimensional array where each element is a token and its frequency. The array is sorted by frequency in descending order.
counter.token_frequency
[
["the", 2],
["are", 2],
["we", 1],
# ...
["all", 1]
]
#most_frequent_tokens
Returns a hash where each key-value pair is a token and its frequency.
counter.most_frequent_tokens
{ "are" => 2, "the" => 2 }
#token_lengths
Returns a sorted (unstable) two-dimentional array where each element contains a token and its length. The array is sorted by length in descending order.
counter.token_lengths
[
["looking", 7],
["gutter", 6],
["stars", 5],
# ...
["in", 2]
]
#longest_tokens
Returns a hash where each key-value pair is a token and its length.
counter.longest_tokens
{ "looking" => 7 }
#token_density([ precision: 2 ])
Returns a sorted (unstable) two-dimentional array where each element contains a token and its density as a float, rounded to a precision of two. The array is sorted by density in descending order. It accepts a precision argument, which must be a float.
counter.token_density
[
["are", 0.13],
["the", 0.13],
["but", 0.07 ],
# ...
["we", 0.07 ]
]
#char_count
Returns the char count of tokens.
counter.char_count #=> 76
#average_chars_per_token([ precision: 2 ])
Returns the average char count per token rounded to two decimal places. Accepts a precision argument which defaults to two. Precision must be a float.
counter.average_chars_per_token #=> 4
#uniq_token_count
Returns the number of unique tokens.
counter.uniq_token_count #=> 13
Excluding tokens from the tokeniser
You can exclude anything you want from the input by passing the exclude option. The exclude option accepts a variety of filters and is extremely flexible.
- A space-delimited string. The filter will normalise the string.
- A regular expression.
- A lambda.
- A symbol that names a predicate method. For example
:odd?. - An array of any combination of the above.
tokeniser =
WordsCounted::Tokeniser.new(
"Magnificent! That was magnificent, Trevor."
)
# Using a string
tokeniser.tokenise(exclude: "was magnificent")
# => ["that", "trevor"]
# Using a regular expression
tokeniser.tokenise(exclude: /trevor/)
# => ["magnificent", "that", "was", "magnificent"]
# Using a lambda
tokeniser.tokenise(exclude: ->(t) { t.length < 4 })
# => ["magnificent", "that", "magnificent", "trevor"]
# Using symbol
tokeniser = WordsCounted::Tokeniser.new("Hello! محمد")
tokeniser.tokenise(exclude: :ascii_only?)
# => ["محمد"]
# Using an array
tokeniser = WordsCounted::Tokeniser.new(
"Hello! اسماءنا هي محمد، كارولينا، سامي، وداني"
)
tokeniser.tokenise(
exclude: [:ascii_only?, /محمد/, ->(t) { t.length > 6}, "و"]
)
# => ["هي", "سامي", "وداني"]
Passing in a custom regexp
The default regexp accounts for letters, hyphenated tokens, and apostrophes. This means twenty-one is treated as one token. So is Mohamad's.
/[\p{Alpha}\-']+/
You can pass your own criteria as a Ruby regular expression to split your string as desired.
For example, if you wanted to include numbers, you can override the regular expression:
counter = WordsCounted.count("Numbers 1, 2, and 3", pattern: /[\p{Alnum}\-']+/)
counter.tokens
#=> ["numbers", "1", "2", "and", "3"]
Opening and reading files
Use the from_file method to open files. from_file accepts the same options as .count. The file path can be a URL.
counter = WordsCounted.from_file("url/or/path/to/file.text")
Gotchas
A hyphen used in leu of an em or en dash will form part of the token. This affects the tokeniser algorithm.
counter = WordsCounted.count("How do you do?-you are well, I see.")
counter.token_frequency
[
["do", 2],
["how", 1],
["you", 1],
["-you", 1], # WTF, mate!
["are", 1],
# ...
]
In this example -you and you are separate tokens. Also, the tokeniser does not include numbers by default. Remember that you can pass your own regular expression if the default behaviour does not fit your needs.
A note on case sensitivity
The program will normalise (downcase) all incoming strings for consistency and filters.
Roadmap
Ability to open URLs
def self.from_url
# open url and send string here after removing html
end
Contributors
See contributors.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Author: abitdodgy
Source code: https://github.com/abitdodgy/words_counted
License: MIT license
#ruby #ruby-on-rails