What is Beefy Finance (BIFI) | What is BIFI token

In this article, we'll discuss information about the Beefy Finance project and BIFI token. What is Beefy Finance (BIFI) | What is BIFI token?

What is Beefy Finance?

Beefy Finance is a Decentralized Finance (DeFi) Yield Optimizer project, that allows its users to make more crypto with crypto. DeFi applications are unique in the sense that they are permissionless and trustless, meaning that anyone with a supported wallet can interact with them without the need for a trusted middlemen. Beefy Finance caters its users by making it easy to get a yield on their crypto capital in a safe and decentralized manner. Through a set of smart contracts and several investment strategies, Beefy Finance automatically maximizes the user rewards from various liquidity pools (LPs), automated market making (AMM) projects, and other yield farming opportunities in the DeFi ecosystem. This provides a huge advantage over attempting to do this manually yourself. Beef up those yields!

The project consists of an anonymous team, directly inspired by the yield optimization projects that had been developed on the Ethereum network. As a team that has been part of the crypto world for many years, we are strong proponents of “Don't Trust, Verify”. This is why data such as our governance token distribution contracts are open for anyone to verify that everything will work as intended. We are committed to this idea of radical transparency, which is especially important in nascent ecosystems like Decentralized Finance.

Beefy Finance offers complex strategies that are simple and intuitive for any investor to take part in through the vault offerings on the platform. The first set of vaults went live on October 8, 2020 on the Binance Smart Chain (BSC), making Beefy Finance the first Yield Optimizer on BSC. Beefy Finance later expanded to many more blockchains (currently 10+ and counting), establishing itself as THE Multichain Yield Optimizer.

From all of the vaults deployed on every blockchain, Beefy Finance has its native governance token $BIFI at its core. Platform revenue is generated from a small percentage of all the vault profits and distributed back to those who stake $BIFI. As a decentralized project with a deeply ingrained crypto-mindset, there is also a robust governance system in place to put the decision-making power in the hands of those invested in the project by governance mechanisms build around $BIFI.

What makes Beefy Finance unique?

There are a few key reasons as to why Beefy Finance differs from a large number of Yield Optimizers out there today.

1. Beefy Finance largely distributes platform revenue back to those who stake $BIFI. With $BIFI, you essentially hold a revenue share in Beefy (when staked).

2. Beefy Finance has more than 10 smart contract developers who carefully test and review our vaults, investment strategies, new platforms and smart contracts before releasing them to the public. Beefy is also actively encouraging developers to participate and engage to make Beefy Finance an even better product.

3. Beefy Finance is flexible and operates on more than one blockchain.

4. Given enough eyeballs, all bugs are shallow. The more widely available the source code is for public testing, scrutiny, and experimentation, the more rapidly all forms of bugs will be discovered. This is a key Beefy principle.

5. Beefy offers unique strategies that other yield optimizers simply do not have. This includes liquidity pool pairs that you can find only on the Beefy platform.

6. The mooVaults for yield optimization boast large APYs that outperform many of our yield farming competitors.

7. Beefy Finance has many recognized partners. This provides the project with credibility and improves overall trust.

Beef Up Those Yields!

We are‌ ‌a‌ ‌team‌ ‌of‌ ‌developers‌ ‌that‌ ‌want‌ ‌to‌ nourish ‌the‌ ‌long‌ ‌term‌ ‌DeFi ecosystem‌ ‌and‌ ‌make‌ ‌it‌ ‌easier‌ ‌for everyone to‌ ‌participate within it.‌ ‌The‌ ‌yield‌ ‌optimization‌ ‌projects ‌created‌ ‌by‌ ‌yearn.finance‌, Andre‌ ‌Cronje‌ ‌and‌ ‌the‌ ‌YFI‌ ‌community have quickly inspired many others. This is an excellent ‌development ‌that‌ ‌is ‌helping‌ to ‌grow‌ and secure ‌the‌ ‌Ethereum‌ ‌ecosystem. However, in recognizing the fundamental properties of other chains, opportunities for significantly different approaches are apparent.

How to Optimize Yield On A Fast Chain 

Yield‌ ‌optimizers‌ ‌on‌ ‌cheap and fast blockchains ‌present‌ ‌a‌ ‌different‌ ‌set‌ ‌of‌ ‌problems, challenges and opportunities.‌ ‌While‌ ‌on‌ ‌Ethereum,‌ where ‌gas‌ ‌fees‌ ‌are‌ ‌high,‌ ‌it‌ ‌makes‌ ‌sense‌ ‌to‌ ‌focus‌ ‌on‌ ‌gas‌ ‌savings, and ‌pooling‌ ‌funds‌ ‌to‌ ‌deploy‌ ‌strategies.‌ ‌On chains where the fees are far smaller, ‌the‌ ‌focus‌ ‌moves‌ ‌to‌ ‌optimizing‌ ‌automation‌ ‌to‌ ‌secure ‌the‌ ‌greatest ‌yields‌ with less concern for the amount of interactions necessary ‌to‌ constantly ‌improve‌ ‌a‌ ‌moving‌ ‌APY.‌ ‌The doors open up to more complex strategies and frequent rebalances.

With‌ this ‌automatization,‌ ‌we‌ ‌can‌ ‌provide‌ ‌a‌ ‌simple‌ ‌way‌ ‌for‌ ‌investors‌ ‌to‌ ‌interact‌ ‌with‌ ‌pools,‌ ‌projects,‌ ‌and‌ ‌other yield‌ ‌opportunities‌ ‌without‌ ‌having‌ ‌to‌ ‌constantly make decisions and take‌ ‌manual‌ ‌actions‌.‌ ‌We‌ ‌see‌ ‌this‌ ‌as‌ ‌a‌ ‌necessary‌ ‌step‌ ‌to‌ ‌leveling‌ ‌the‌ ‌playing‌ ‌field,‌ ‌allowing‌ ‌small‌ ‌investors‌ ‌to‌ ‌have‌ ‌access‌ ‌to‌ ‌the‌ ‌same‌ ‌opportunities‌ ‌that‌ ‌so‌ ‌far‌ ‌only‌ ‌whales‌ and full-time yield-farmers on Ethereum ‌have‌ ‌had‌ ‌access‌ ‌to.‌ ‌ ‌

Our long term goal is to help projects in DeFi grow together, providing help with auditing, creating hackathons for interesting strategies to add to the platform, etc. All of this will be coordinated decentralized by the community and the holders of the governance token $BIFI.

Tokenomics & Governance

What is $BIFI?

$BIFI tokens are revenue shares in Beefy Finance, through which holders earn profits generated by Beefy Finance when staked, and are entitled to vote on important platform decisions.

Max Supply: 80,000 BIFI token 

$BIFI, otherwise known as BIFI, is the native governance token of our project. By staking it in a BIFI Maxi vault, the BIFI earnings pool or any BIFI liquidity vault, or by simply holding this token in your wallet, users can take part in the DAO decision-making governance processes of Beefy Finance. It does not matter on which chain you hold or stake BIFI, since the governance snapshot is multi-chain compatible. Governance proposals are submitted on https://vote.beefy.finance/#/ and users are encouraged to vote. Users do not need to un-stake their tokens to participate in the voting process. This incentivizes much more voter participation as it means users don’t miss rewards.

For all the vaults deployed on every blockchain, Beefy Finance has its native governance token $BIFI at its core. Platform revenue is generated from a small percentage of all the vault profits and distributed back to those who stake $BIFI. The revenue sharing mechanics entail you can stake $BIFI to either earn more $BIFI in a BIFI Maxi Vault, or earn blue chips like $ETH, $BNB, $FTM, $MATIC, $AVAX, and more in the BIFI Earnings Pools.

After an initial distribution period of around two months back in Q4 2020, 72,000 tokens were supplied to the community with 8,000 being locked for the founding team. All 80,000 BIFI will be in circulation by 2022-07-06. 

$BIFI staked in the BIFI Maxi vault allows users to accumulate more $BIFI. In order to distribute BIFI to anyone who has staked in the BIFI Maxi vault, $BIFI buy-backs from the open market are performed as the token is non-inflationary and will not mint any more BIFI tokens, ever.

To get your hands on BIFI, head to one of the many liquidity pools or exchanges.

How is the protocol revenue distributed?

All revenue generated on the platform from vault fees is sent to and handled by the RewardPool smart contract in the form of the native token of the chain. Anyone who stakes their $BIFI in either a BIFI Earnings Pool or a BIFI Maxi vault receives their proportional share.

What’s the BIFI Maxi vault?

The BIFI Maxi vault allows users to stake their $BIFI much like in the native token earnings pool, but receive instead their rewards in $BIFI. By staking their $BIFI, each participant converts and compounds their share of the protocol’s revenue into more BIFI tokens. As no more BIFI tokens are to be minted, these are provided to stakers by buying BIFI from the open market with the native token of the blockchain.

This Vault is for users that want to convert and compound their share of the protocol's revenue in more BIFI tokens. As BIFI has no inflation, the strategy market buys BIFI with native token rewards.

Where can I buy $BIFI?

$BIFI can currently be found in several decentralized exchanges including 1inch and PancakeSwap. Buying $BIFI usually involves exchanging it for another crypto-coin or token through a liquidity pool.

How do I take part in governance?

By simply holding $BIFI, even if staked in the native token earnings pool or BIFI Maxi vault, a user earns the right to create proposals and vote in them. Voting sway and power are derived from the $BIFI holdings of the participant. The reasoning behind this follows that those holding more $BIFI are more invested in the project, and therefore have a larger incentive for the platform itself to succeed and prosper. You can see proposals and vote on them yourself by heading to vote.beefy.finance.

How do I vote?

Voting requires you to hold $BIFI, which can either simply be held in your wallet or staked in the native token earnings pool or BIFI Maxi vaults. You do not need to remove your stake either to vote. Voting power is based directly on the amount of $BIFI each voter holds.

How do I create a proposal?

Proposals can be created if the submitter holds or stakes at least 1 $BIFI. Simply visit https://vote.beefy.finance/#/ and click New Proposal.

Each proposal is made up of a question to pose to the community, along with the option of choices that others can vote on in response to your question. Simply set a start and end date for your proposal and publish it.

How and Where to Buy BIFI token?

BIFI 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, BNB 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 BIFI token

You will have to first buy one of the major cryptocurrencies, usually either Bitcoin (BTC), Ethereum (ETH), Tether (USDT), Binance (BNB)…

We will use Binance Exchange here as it is one of the largest crypto exchanges that accept fiat deposits.

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), Binance (BNB)…

☞ SIGN UP ON BINANCE

Step by Step Guide : What is Binance | How to Create an account on Binance (Updated 2022)

Once finished you will then need to make a BTC/ETH/USDT/BNB deposit to the exchange from Binance depending on the available market pairs. After the deposit is confirmed you may then purchase BIFI from the exchange.

The top exchange for trading in BIFI token is currently: Binance, BingX, Gate.io, Crypto.com Exchange, and Hoo

🔺DISCLAIMER: The Information in the post isn’t financial advice, is intended FOR GENERAL INFORMATION PURPOSES ONLY. Trading Cryptocurrency 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

Find more information BIFI token ☞ Website

I hope this post will help you. Don't forget to leave a like, comment and sharing it with others. Thank you!

#bitcoin #cryptocurrency 

What is GEEK

Buddha Community

What is Beefy Finance (BIFI) | What is BIFI token

What is Bifi Finance (BIFI) | What is Bifi Finance token | What is BIFI token

BiFi (Bifrost Finance) is a multichain DeFi project powered by Bifrost’s multichain technology. BiFi connects not only Ethereum based tokens, but also other tokens from different blockchains such as Bitcoin, Tron and Klaytn. BiFi will offer multichain wallet, lending, borrowing, and staking services, as well as yield farming rewards and other multichain investment products.

What makes BiFi unique?

Bifrost: BiFi is powered by the multichain technology of Bifrost. With Bifrost, BiFi can use different tokens and coins from different blockchains and protocols on its services. Through multichain connectivity, BiFi will lower the gas fees, increase accessibility, and expand the ecosystem to enable more innovative financial products to more people. Bifrost Wallet: Bifrost Wallet is a multichain wallet that supports multichain DeFi products and services on BiFi. Users can use multichain services such as lending and borrowing using Bifrost Wallet. Security Focused: Hacks and frauds have tainted the blockchain ecosystem. Our team of hackers, researchers, and security experts are dedicated to maintaining the highest standards of security. With us, you can securely put your money to work. ### What are its use cases? BIFI token serves multiple functions on BiFi’s multichain DeFi platform. It can be used as a governance token, used to vote on proposals to enhance or submit proposals for BiFi. It can also be used as a currency to pay for multichain DeFi services on BiFi.

What is BIFI Token?

BIFI token is the governance token for BiFi — the multichain DeFi platform for borrowing, lending, and investing. Holders of BIFI token can vote on proposals to improve the BiFi service. Users will also be able to use BIFI token for various financial services on BiFi, such as investment, insurance, and trading. Lastly, BIFI token is going to be used as a fee when using multichain services. As BiFi is built on the multichain middleware platform Bifrost, it needs to lock-up and pay a certain amount of BFC (Bifrost token) when using Bifrost.

What is BIFI Token Distribution Plan?

There will be a total of 1B BIFI tokens. Initial supply of BIFI token is 100M — 10% of total supply.

The BIFI token will be distributed in two ways:

  1. 50M BIFI tokens will be distributed in the first month BiFi launches and can be earned by BFC/ETH liquidity pool mining or BFC staking on BiFi.
  2. 50M BIFI tokens will be initially supplied on Uniswap.

40% of 1B BIFI tokens is allocated to Service Incentives. 20% is allocated for Yield Farming, which includes liquidity pool mining (BFC/ETH) and staking (BFC). Then, 15% is allocated to Team and 15% to Treasury & insurance.

After the initial distribution of 100M BIFI tokens, 36%, 27%, 18%, and 9% of BIFI tokens will be distributed for the next four years, respectively. When all 1B BIFI tokens have been distributed, 2% of 1B BIFI tokens will be inflated each year.

See the chart below to see the details of BIFI token distribution:

📌 Distribution of token can be changed through governance of BiFi.

Image for post

BiFi Token Circulation Ration

How to Earn BIFI Token

There are three ways to earn BIFI tokens:

1. Purchase BIFI tokens on exchanges.

2. Earn BIFI tokens by liquidity pool mining (BFC/ETH) and staking (BFC) on BiFi.

3. Earn BIFI tokens as a Service Incentive, an incentive to BiFi service users who lend or borrow assets on BiFi. Service Incentive will be added shortly.

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

How and Where to Buy BIF?

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

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)

After the deposit is confirmed you may then purchase BIFI from the exchange.

Exchange: The top exchanges for trading in Beefy.Finance are currently Binance, PancakeSwap, and OpenOcean

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

https://www.bittrex.com
https://www.poloniex.com
https://www.bitfinex.com
https://www.huobi.com
https://www.mxc.ai
https://www.probit.com
https://www.gate.io
https://www.coinbase.com

Find more information BIFI

☞ Website
☞ Explorer
☞ Whitepaper
☞ Source Code
☞ Social Channel
Message Board
☞ Documentation
☞ Coinmarketcap

🔺DISCLAIMER: Trading Cryptocurrency is VERY risky. Make sure that you understand these risks if you are a beginner. The Information in the post is my OPINION and not financial advice. You are responsible for what you do with your funds

I hope this post will help you. If you liked this, please sharing it with others. Thank you!

#blockchain #bitcoin #crypto #bifi finance #bifi

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

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 

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