What is Narwhale.finance (NAWA) |  What is Narwhale token | What is NAWA token

Narwhale.finance aims to provide yield farming opportunities for algorithmic stablecoins, as well as non USD stablecoins like EURS or sEUR, a niche that has recently taken DeFi by storm.

Our initial attention was funneled to non USD stablecoins, but given their low market capitalization, we were forced to reassess and came to the conclusion that algo stablecoins were the subject we would like to tackle.

Image for post

The initial plan

Our initial plan was to fill the asset management and yield farming gap between USD and non USD stablecoins.

After extensive research, we have concluded that the current supply of EUR, SGD, GBP, and other currencies is very low, but it does not mean that at some point it won’t lift off.

The regulatory sandbox is being put in place for a possible digital euro, for instance. Other entities like Statis EURO or Syntetix’ foreign currencies are already on top of their game and can easily expand once the demand picks up.

When they do, we plan to offer them a home.

We are already handling EURS, sEUR and one of the first vaults would surely be Curve EURS-sEUR pool.

The pivot to algo stablecoins

Until then, we have pivoted to the current craze which is algorithmic stablecoins. Each of them has something to offer but has yet to prove itself.

Not all of them will survive, but Narwhale.finance aims to be the go-to place for those that provide value and utility.

The future plan

What do I mean by “a go-to place”? A platform that can manage users’ funds deposited into vaults acting as proxies for different yield farming strategies available for a given stablecoin, as long as there’s an opportunity out there.

I have mentioned above the EURS-sEUR vault. That is an obvious one. We can see an opportunity in handling FRAX’s internal affairs, for instance. A strategy cand and will be built on top of that.

What’s in it for narwhale.finance? A % of the strategy’s performance will go to the treasury. The treasury will be distributed to NAWA holders staking their tokens.

What about the user? Hassle-free asset management.

You know the drill, you have seen it on yearn.finance and other decentralized asset management. We just plan to tackle the algo stablecoin niche, as BADGER did to wBTC.

We would like to change the current UI, which is mostly used for farming and NAWA distribution, to a proper dashboard.

Image for post

The theme on top of which we will build the dashboard

At the same time, we are working on developing our first vaults and strategies and will not be released without a proper audit. Both the development and the audit itself take time and would not see the light of day until at least a couple of weeks.

The next step would be to add lending/borrowing option for EUR stablecoin and proven algo/seigniorage stablecoins.

Our value proposition is to offer this range of tools for stablecoins holders.

Addressing some of the concerns

  • Why not develop first, token later? DeFi is innovating and launching products at a rapid pace and sometimes keeping a product hidden for too long would mean a lost opportunity.

We have basically distributed NAWA to stablecoin related investors that might keep interest in narwhale’s future plan. The future plan is to reward NAWA stakers with protocol-generated fees.

  • Governance is also on the roadmap, but we would like to put in place an anti-gaming mechanism and voting based on voter’s capabilities, but to be perfectly honest we do not currently have details about how it would work. Worst case scenario, we implement the ordinary governance flow.
  • The emission rate seems too steep for the demand that is currently expressing. Because of this, we have decided to END the current
  • pool rewards at block 11742897 which is in roughly 50h:  https://etherscan.io/block/countdown/11742897
  • The NAWA-USDC pool will still receive rewards at a rate of 10 NAWA/block
  • This 10NAWA/block emission will last until the first vaults release at which point we will reassess the emission and incentivize the vaults usage.
  • The current circulation supply has no hard cap, but the plan is to migrate to governance before it actually reaches the appointed tail emission (70M in 5 years).
  • At this point, the minting can be accessed only through the distribution contract and it mints NAWA only on attached pools whenever someone is depositing/withdrawing based on weights. As stated above, the plan is to eventually migrate to governance, but before that, on vaults release, we will be transferring the ownership to multisig wallet. Until then, if needed, we can implement timelock.
  • There was no audit before launching the distribution because the contract has been battle-tested on Sushi’s launch and the code is based on it with small changes. We also run a series of automated tests that provided an additional confirmation that the contract is safe to use and the user’s funds are not in danger.
  • The future releases will be made after proper audits.
  • The 10% dev fee should be self-explanatory. We did not farm the initial distribution, we are self-funded and we would also like to be incentivized to keep on running. No vesting has been considered at launch
  • because at some point in time we would need to reward ourselves for the time, effort, and operation costs.

The Grand Design

  • Narwhale.finance will farm the highest yielding algo stablecoins deposited into vaults by users who would like their funds to be taken care of in a non-custodial fashion.
  • New strategies will be developed and deployed to keep up with the racing pace that DeFi is currently innovating.
  • On top of automatically harvested rewards provided by stablecoins, users will receive an additional incentive in the form of NAWA token.
  • NAWA token will eventually migrate to governance, though our view of it is that not everyone should be able to vote on protocol issues on which they do not possess the necessary economic or technical knowledge.
  • Users will be able to lend and borrow algo stablecoins.
  • 100% of fees generated by the platform will be distributed to NAWA holders through staking.

NAWA token initial distribution & protocol jumpstart

  • Receive NAWA by staking non USD and algo stablecoins.
  • 70 000 000 NAWA tokens distributed over 5 years with no hard cap.
  • 0 circulating supply at launch.
  • NAWA will be minted when staking the following stablecoins or liquidity pool tokens:

sUSD, sEUR, EURS, FRAX, DSD, ESD, AMPL, MIC, BAC, BASED, Sushi-MIC-USDT, Uniswap-FRAX-USDC, Uniswap-BAC-DAI, Uniswap-AMPL-ETH, Moonbased, Curve, EURS-sEUR, Uniswap-NAWA-ETH

  • The boostrapping emission period will distribute 100 NAWA per block for the first 2 weeks (roughly 15% of the supply), after which the above-mentioned pools will stop receiving rewards.
  • After two weeks the rewards will migrate to vaults and pool 2 at a pace of 20 NAWA per block for the next month.
  • The allocation % points for each of the above pools will be proportionally set by market capitalization at the time of writing.
  • 10% of block distribution goes to the development fund. Please see Andre’s rant which we currently agree on. We believe developer incentivization is critical for long-term project development and success.

Short term roadmap in no particular order

  • Launch, deploy and audit vaults and yield farming strategies
  • v2 interface design
  • lend/borrow algo stablecoins

How and Where to Buy NAWA?

NAWA 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 NAWA

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)

SIGN UP ON BINANCE

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 NAWA is an altcoin we need to transfer our coins to an exchange that NAWA can be traded. Below is a list of exchanges that offers to trade NAWA 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 NAWA from the exchange.

Exchange: HitBTC, and P2PB2B

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 NAWA 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

BinanceBittrexPoloniexBitfinexHuobiMXCProBITGate.ioCoinbase

Looking for more information…

WebsiteExplorerExplorer 2Source CodeSocial ChannelMessage BoardMessage Board 2Coinmarketcap

Would you like to earn NAWA right now! ☞ CLICK HERE

Thank for visiting and reading this article! I’m highly appreciate your actions! Please share if you liked it!

#blockchain #bitcoin #narwhale.finance #nawa

What is GEEK

Buddha Community

What is Narwhale.finance (NAWA) |  What is Narwhale token | What is NAWA token

What is Narwhale.finance (NAWA) |  What is Narwhale token | What is NAWA token

Narwhale.finance aims to provide yield farming opportunities for algorithmic stablecoins, as well as non USD stablecoins like EURS or sEUR, a niche that has recently taken DeFi by storm.

Our initial attention was funneled to non USD stablecoins, but given their low market capitalization, we were forced to reassess and came to the conclusion that algo stablecoins were the subject we would like to tackle.

Image for post

The initial plan

Our initial plan was to fill the asset management and yield farming gap between USD and non USD stablecoins.

After extensive research, we have concluded that the current supply of EUR, SGD, GBP, and other currencies is very low, but it does not mean that at some point it won’t lift off.

The regulatory sandbox is being put in place for a possible digital euro, for instance. Other entities like Statis EURO or Syntetix’ foreign currencies are already on top of their game and can easily expand once the demand picks up.

When they do, we plan to offer them a home.

We are already handling EURS, sEUR and one of the first vaults would surely be Curve EURS-sEUR pool.

The pivot to algo stablecoins

Until then, we have pivoted to the current craze which is algorithmic stablecoins. Each of them has something to offer but has yet to prove itself.

Not all of them will survive, but Narwhale.finance aims to be the go-to place for those that provide value and utility.

The future plan

What do I mean by “a go-to place”? A platform that can manage users’ funds deposited into vaults acting as proxies for different yield farming strategies available for a given stablecoin, as long as there’s an opportunity out there.

I have mentioned above the EURS-sEUR vault. That is an obvious one. We can see an opportunity in handling FRAX’s internal affairs, for instance. A strategy cand and will be built on top of that.

What’s in it for narwhale.finance? A % of the strategy’s performance will go to the treasury. The treasury will be distributed to NAWA holders staking their tokens.

What about the user? Hassle-free asset management.

You know the drill, you have seen it on yearn.finance and other decentralized asset management. We just plan to tackle the algo stablecoin niche, as BADGER did to wBTC.

We would like to change the current UI, which is mostly used for farming and NAWA distribution, to a proper dashboard.

Image for post

The theme on top of which we will build the dashboard

At the same time, we are working on developing our first vaults and strategies and will not be released without a proper audit. Both the development and the audit itself take time and would not see the light of day until at least a couple of weeks.

The next step would be to add lending/borrowing option for EUR stablecoin and proven algo/seigniorage stablecoins.

Our value proposition is to offer this range of tools for stablecoins holders.

Addressing some of the concerns

  • Why not develop first, token later? DeFi is innovating and launching products at a rapid pace and sometimes keeping a product hidden for too long would mean a lost opportunity.

We have basically distributed NAWA to stablecoin related investors that might keep interest in narwhale’s future plan. The future plan is to reward NAWA stakers with protocol-generated fees.

  • Governance is also on the roadmap, but we would like to put in place an anti-gaming mechanism and voting based on voter’s capabilities, but to be perfectly honest we do not currently have details about how it would work. Worst case scenario, we implement the ordinary governance flow.
  • The emission rate seems too steep for the demand that is currently expressing. Because of this, we have decided to END the current
  • pool rewards at block 11742897 which is in roughly 50h:  https://etherscan.io/block/countdown/11742897
  • The NAWA-USDC pool will still receive rewards at a rate of 10 NAWA/block
  • This 10NAWA/block emission will last until the first vaults release at which point we will reassess the emission and incentivize the vaults usage.
  • The current circulation supply has no hard cap, but the plan is to migrate to governance before it actually reaches the appointed tail emission (70M in 5 years).
  • At this point, the minting can be accessed only through the distribution contract and it mints NAWA only on attached pools whenever someone is depositing/withdrawing based on weights. As stated above, the plan is to eventually migrate to governance, but before that, on vaults release, we will be transferring the ownership to multisig wallet. Until then, if needed, we can implement timelock.
  • There was no audit before launching the distribution because the contract has been battle-tested on Sushi’s launch and the code is based on it with small changes. We also run a series of automated tests that provided an additional confirmation that the contract is safe to use and the user’s funds are not in danger.
  • The future releases will be made after proper audits.
  • The 10% dev fee should be self-explanatory. We did not farm the initial distribution, we are self-funded and we would also like to be incentivized to keep on running. No vesting has been considered at launch
  • because at some point in time we would need to reward ourselves for the time, effort, and operation costs.

The Grand Design

  • Narwhale.finance will farm the highest yielding algo stablecoins deposited into vaults by users who would like their funds to be taken care of in a non-custodial fashion.
  • New strategies will be developed and deployed to keep up with the racing pace that DeFi is currently innovating.
  • On top of automatically harvested rewards provided by stablecoins, users will receive an additional incentive in the form of NAWA token.
  • NAWA token will eventually migrate to governance, though our view of it is that not everyone should be able to vote on protocol issues on which they do not possess the necessary economic or technical knowledge.
  • Users will be able to lend and borrow algo stablecoins.
  • 100% of fees generated by the platform will be distributed to NAWA holders through staking.

NAWA token initial distribution & protocol jumpstart

  • Receive NAWA by staking non USD and algo stablecoins.
  • 70 000 000 NAWA tokens distributed over 5 years with no hard cap.
  • 0 circulating supply at launch.
  • NAWA will be minted when staking the following stablecoins or liquidity pool tokens:

sUSD, sEUR, EURS, FRAX, DSD, ESD, AMPL, MIC, BAC, BASED, Sushi-MIC-USDT, Uniswap-FRAX-USDC, Uniswap-BAC-DAI, Uniswap-AMPL-ETH, Moonbased, Curve, EURS-sEUR, Uniswap-NAWA-ETH

  • The boostrapping emission period will distribute 100 NAWA per block for the first 2 weeks (roughly 15% of the supply), after which the above-mentioned pools will stop receiving rewards.
  • After two weeks the rewards will migrate to vaults and pool 2 at a pace of 20 NAWA per block for the next month.
  • The allocation % points for each of the above pools will be proportionally set by market capitalization at the time of writing.
  • 10% of block distribution goes to the development fund. Please see Andre’s rant which we currently agree on. We believe developer incentivization is critical for long-term project development and success.

Short term roadmap in no particular order

  • Launch, deploy and audit vaults and yield farming strategies
  • v2 interface design
  • lend/borrow algo stablecoins

How and Where to Buy NAWA?

NAWA 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 NAWA

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)

SIGN UP ON BINANCE

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 NAWA is an altcoin we need to transfer our coins to an exchange that NAWA can be traded. Below is a list of exchanges that offers to trade NAWA 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 NAWA from the exchange.

Exchange: HitBTC, and P2PB2B

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 NAWA 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

BinanceBittrexPoloniexBitfinexHuobiMXCProBITGate.ioCoinbase

Looking for more information…

WebsiteExplorerExplorer 2Source CodeSocial ChannelMessage BoardMessage Board 2Coinmarketcap

Would you like to earn NAWA right now! ☞ CLICK HERE

Thank for visiting and reading this article! I’m highly appreciate your actions! Please share if you liked it!

#blockchain #bitcoin #narwhale.finance #nawa

Angelina roda

Angelina roda

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!

David mr

David mr

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

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.

  1. A space-delimited string. The filter will normalise the string.
  2. A regular expression.
  3. A lambda.
  4. A symbol that names a predicate method. For example :odd?.
  5. 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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Author: abitdodgy
Source code: https://github.com/abitdodgy/words_counted
License: MIT license

#ruby  #ruby-on-rails 

Royce  Reinger

Royce Reinger

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.

  1. A space-delimited string. The filter will normalise the string.
  2. A regular expression.
  3. A lambda.
  4. A symbol that names a predicate method. For example :odd?.
  5. 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.

Gem Version 

RubyDoc documentation.

Demo

Visit this website for one example of what you can do with WordsCounted.


Contributors

See contributors.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Author: Abitdodgy
Source Code: https://github.com/abitdodgy/words_counted 
License: MIT license

#ruby #nlp