What is Penguin Finance (PEFI) | What is Penguin Finance token | What is PEFI token

In this article, we’ll discuss information about the Penguin Finance project and PEFI token

Penguin Finance is a DeFi protocol. It was created as a solution to both the high-technicality requirements and exclusion due to high gas fees. Building an innovative set of decentralized applications, financial products, and documentation, the team aims to provide a smooth DeFi experience to its users. Currently, Penguin Finance offers yield-farming, staking, and the Emperor Penguin game to provide plenty of earning opportunities and utility to its native token, PEFI.

Everyone within the PeFi Community will be able to access (and collect fees from):

  • Penguin Igloos - intuitive UX design and in-depth documentation so that even your grandma can increase her APY.
  • Penguin Nests - a $PEFI staking system designed to reward Penguins with incentives and fees collected by the Penguin Ecosystem.
  • Penguin Compounder - an innovative auto-compounding protocol with auto-nesting features and rewards for pool creators.
  • Penguin Launchpad - A fundraising platform for penguins rather than whales, and a fair distribution of allocation power.
  • Penguin Emperor: a customizable, fast and beautifully illustrated dApp.
  • The Penguin Arena - a high-stakes competition, only for the bravest of Penguins.
  • CryptoPenguins - our unique twist on NFTs with intrinsic utility and value. They’ll collect fees generated by dApps within PeFi and distribute them to their owners.
  • Penguin Collectibles - Beautiful 3D Penguin Models with cosmetic value inside of the Penguin Emperor.
  • Prediction Markets - ultra-low fee with no barriers of entry.
  • And other projects to come.

Penguin (PEFI) TOKEN

Ticker: PEFI

Contract address: 0xe896CDeaAC9615145c0cA09C8Cd5C25bced6384c

Chain: Avalanche C-Chain (ERC-20)

Max Supply: 21,000,000 PEFI

Emission Rate: The target long-term emission rate is 1 PEFI/block (considering 1s block times). Given this block speeds will most likely be higher, emission rates will be adjusted to target a set amount of PEFI per week. The initial rate of 6.15 PEFI/block during the Turbo Phase will be lowered gradually over time.

Block Time Explanation

10% of minted PEFI goes to the team’s address as incentives and to hire more developers for further project growth. There are no pre-allocated developer funds.

Token Utility

As longtime users of crypto, we understand that there is an excess of projects and tokens that have no actual utility or long-term value propositions, which is why we’ve come together to excel from the rest.

The $PEFI token is the lifeblood of the Penguin Finance Ecosystem. Penguins are able to stake their tokens to receive both staking rewards and fees that are collected by applications within the Penguin Finance Ecosystem. Rather than being purely speculative, PEFI’s value is derived from the fees that are collected from the protocol’s users and its utility within PeFi, as well as burning mechanisms. PEFI tokens will have a wide arrange of applications ranging from their use in custom yield farming strategies, our upcoming ultra low-fee Prediction Markets, NFTs, and the famed Penguin Arena.

The Penguin Community is always proposing new use cases and additions to the PEFI token whose supply mechanisms have been built with long-term holders in mind. It is against our nature to dilute Early Penguins for the benefit of others, the PEFI token has many built-in burning mechanisms and deflationary implementations to ensure it is continuously appreciating in value for both newcomers and legacy holders.

​PEFI Distribution

Token Distribution

50% Liquidity Providers & Staking: To reward our fellow Penguins for staking their funds and adding liquidity into the Penguin Ecosystem, half of the supply will be distributed as incentives via the Penguin Igloos (yield farming pools) and the Penguin Nests (staking).

5% Marketing & Community Endowment: In order to ensure PeFi can get to as many people as possible, this allocation will be used for creating competitions such as our recent NFT Artwork Competition and other creative ideas that will drive community engagement, social media exposure, and help support content creators within the Penguin Finance Community. This allocation will allow us to organically grow the project, compensate designers, and community managers.

25% Airdrops: To expand the PeFi Vision and reach as many Penguins as we can around the globe, this allocation will be distributed in several small key strategic distributions within a time span of 3 years to guarantee that they don’t affect $PEFI’s value short-term.

10% Team Allocation: Given PeFi’s mission is to continue pushing out excellent code and features for the coming decade, we will use this allocation to onboard new developers, designers, and marketers into the team and make sure everyone can be a full-time Penguin. This is distributed by the MasterChef rather than being minted beforehand, meaning there is no preallocation.

10% Penguin DAO Treasury: This allocation of the total supply will be held by the Penguin DAO which will be free to use the funds for whatever the Penguin Community sees fit in the future. They may be burnt, distributed, or used for creative proposals that our community will be able to vote on in the future. Given the project is in its early stages and the Penguin DAO isn’t yet live, the funds will not be allocated yet to not make the circulating supply of PEFI appear larger than it really is.

Deflationary Mechanisms

In order to increase $PEFI’s value over time and balance the circulating supply of our token, the token was engineered with several key burning mechanisms in place:

  • 3% of all withdrawals from the Penguin Igloos are used to market buy $PEFI and burn it.
  • 100% of the paper hands penalty (PPL) collected from the Penguin Nests is immediately burnt. This in turn increases the value of investors that are inside of the Nests, as the circulating supply has been lowered.
  • A percentage of the fees generated by the following dApps will also be used to market buy $PEFI and immediately burn it forever:
  • Penguin Arena
  • Penguin Emperor
  • Prediction Markets
  • CryptoPenguins
  • Other upcoming dApps

These features reduce the amount of $PEFI to ever be created, making it impossible for circulating supply to ever reach the established hard cap of 21,000,000 PEFI tokens.

Airdrops

An astonishing 25% of the Total PEFI supply will be distributed in a fair fashion by airdropping it to our community and several key projects that will help further the Penguin Mission, both appreciating the value and reach of our token.

We understand that many are concerned given the history of famous projects crashing the price of their token and hurting original HODLers by diluting it through massive airdrops. Given Penguin Finance is a long-term project with a dedicated team of supporters, we aren’t in any rush to airdrop the entire allocation of PEFI. Early Penguins will receive their fair share of PEFI to ensure no Penguin is left behind.

To better protect the holders of our tokens, we have designed a strategic agenda, distributing the 25% airdrop allocation in small key airdrops over a long time frame. Additionally, in the mid-term, depending on the community that’s being targeted, we’re implementing time lock mechanisms and penalties to punish newcomers who plan to dump the token as soon they receive it.

Our number one priority will always be to protect the value of our token and ensure Penguins’ wealth continues to grow alongside the project.

How and Where to Buy PEFI token?

PEFI 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 PEFI 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.

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

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 PEFI is an altcoin we need to transfer our coins to an exchange that PEFI can be traded. Below is a list of exchanges that offers to trade PEFI 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/BNB deposit to the exchange from Binance depending on the available market pairs. After the deposit is confirmed you may then purchase PEFI from the exchange.

The top exchange for trading in PEFI token is currently PEFI

Find more information PEFI

WebsiteWebsite 2ExplorerSource CodeSocial ChannelSocial Channel 2Social Channel 3Message BoardDocumentationCoinmarketcap

🔺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

⭐ ⭐ ⭐The project is of interest to the community. Join to Get free ‘GEEK coin’ (GEEKCASH coin)!

☞ **-----https://geekcash.org-----**⭐ ⭐ ⭐

Thank for visiting and reading this article! Please don’t forget to leave a like, comment and share!

#blockchain #bitcoin #pefi #penguin finance

What is GEEK

Buddha Community

What is Penguin Finance (PEFI) | What is Penguin Finance token | What is PEFI token

What is Penguin Finance (PEFI) | What is Penguin Finance token | What is PEFI token

In this article, we’ll discuss information about the Penguin Finance project and PEFI token

Penguin Finance is a DeFi protocol. It was created as a solution to both the high-technicality requirements and exclusion due to high gas fees. Building an innovative set of decentralized applications, financial products, and documentation, the team aims to provide a smooth DeFi experience to its users. Currently, Penguin Finance offers yield-farming, staking, and the Emperor Penguin game to provide plenty of earning opportunities and utility to its native token, PEFI.

Everyone within the PeFi Community will be able to access (and collect fees from):

  • Penguin Igloos - intuitive UX design and in-depth documentation so that even your grandma can increase her APY.
  • Penguin Nests - a $PEFI staking system designed to reward Penguins with incentives and fees collected by the Penguin Ecosystem.
  • Penguin Compounder - an innovative auto-compounding protocol with auto-nesting features and rewards for pool creators.
  • Penguin Launchpad - A fundraising platform for penguins rather than whales, and a fair distribution of allocation power.
  • Penguin Emperor: a customizable, fast and beautifully illustrated dApp.
  • The Penguin Arena - a high-stakes competition, only for the bravest of Penguins.
  • CryptoPenguins - our unique twist on NFTs with intrinsic utility and value. They’ll collect fees generated by dApps within PeFi and distribute them to their owners.
  • Penguin Collectibles - Beautiful 3D Penguin Models with cosmetic value inside of the Penguin Emperor.
  • Prediction Markets - ultra-low fee with no barriers of entry.
  • And other projects to come.

Penguin (PEFI) TOKEN

Ticker: PEFI

Contract address: 0xe896CDeaAC9615145c0cA09C8Cd5C25bced6384c

Chain: Avalanche C-Chain (ERC-20)

Max Supply: 21,000,000 PEFI

Emission Rate: The target long-term emission rate is 1 PEFI/block (considering 1s block times). Given this block speeds will most likely be higher, emission rates will be adjusted to target a set amount of PEFI per week. The initial rate of 6.15 PEFI/block during the Turbo Phase will be lowered gradually over time.

Block Time Explanation

10% of minted PEFI goes to the team’s address as incentives and to hire more developers for further project growth. There are no pre-allocated developer funds.

Token Utility

As longtime users of crypto, we understand that there is an excess of projects and tokens that have no actual utility or long-term value propositions, which is why we’ve come together to excel from the rest.

The $PEFI token is the lifeblood of the Penguin Finance Ecosystem. Penguins are able to stake their tokens to receive both staking rewards and fees that are collected by applications within the Penguin Finance Ecosystem. Rather than being purely speculative, PEFI’s value is derived from the fees that are collected from the protocol’s users and its utility within PeFi, as well as burning mechanisms. PEFI tokens will have a wide arrange of applications ranging from their use in custom yield farming strategies, our upcoming ultra low-fee Prediction Markets, NFTs, and the famed Penguin Arena.

The Penguin Community is always proposing new use cases and additions to the PEFI token whose supply mechanisms have been built with long-term holders in mind. It is against our nature to dilute Early Penguins for the benefit of others, the PEFI token has many built-in burning mechanisms and deflationary implementations to ensure it is continuously appreciating in value for both newcomers and legacy holders.

​PEFI Distribution

Token Distribution

50% Liquidity Providers & Staking: To reward our fellow Penguins for staking their funds and adding liquidity into the Penguin Ecosystem, half of the supply will be distributed as incentives via the Penguin Igloos (yield farming pools) and the Penguin Nests (staking).

5% Marketing & Community Endowment: In order to ensure PeFi can get to as many people as possible, this allocation will be used for creating competitions such as our recent NFT Artwork Competition and other creative ideas that will drive community engagement, social media exposure, and help support content creators within the Penguin Finance Community. This allocation will allow us to organically grow the project, compensate designers, and community managers.

25% Airdrops: To expand the PeFi Vision and reach as many Penguins as we can around the globe, this allocation will be distributed in several small key strategic distributions within a time span of 3 years to guarantee that they don’t affect $PEFI’s value short-term.

10% Team Allocation: Given PeFi’s mission is to continue pushing out excellent code and features for the coming decade, we will use this allocation to onboard new developers, designers, and marketers into the team and make sure everyone can be a full-time Penguin. This is distributed by the MasterChef rather than being minted beforehand, meaning there is no preallocation.

10% Penguin DAO Treasury: This allocation of the total supply will be held by the Penguin DAO which will be free to use the funds for whatever the Penguin Community sees fit in the future. They may be burnt, distributed, or used for creative proposals that our community will be able to vote on in the future. Given the project is in its early stages and the Penguin DAO isn’t yet live, the funds will not be allocated yet to not make the circulating supply of PEFI appear larger than it really is.

Deflationary Mechanisms

In order to increase $PEFI’s value over time and balance the circulating supply of our token, the token was engineered with several key burning mechanisms in place:

  • 3% of all withdrawals from the Penguin Igloos are used to market buy $PEFI and burn it.
  • 100% of the paper hands penalty (PPL) collected from the Penguin Nests is immediately burnt. This in turn increases the value of investors that are inside of the Nests, as the circulating supply has been lowered.
  • A percentage of the fees generated by the following dApps will also be used to market buy $PEFI and immediately burn it forever:
  • Penguin Arena
  • Penguin Emperor
  • Prediction Markets
  • CryptoPenguins
  • Other upcoming dApps

These features reduce the amount of $PEFI to ever be created, making it impossible for circulating supply to ever reach the established hard cap of 21,000,000 PEFI tokens.

Airdrops

An astonishing 25% of the Total PEFI supply will be distributed in a fair fashion by airdropping it to our community and several key projects that will help further the Penguin Mission, both appreciating the value and reach of our token.

We understand that many are concerned given the history of famous projects crashing the price of their token and hurting original HODLers by diluting it through massive airdrops. Given Penguin Finance is a long-term project with a dedicated team of supporters, we aren’t in any rush to airdrop the entire allocation of PEFI. Early Penguins will receive their fair share of PEFI to ensure no Penguin is left behind.

To better protect the holders of our tokens, we have designed a strategic agenda, distributing the 25% airdrop allocation in small key airdrops over a long time frame. Additionally, in the mid-term, depending on the community that’s being targeted, we’re implementing time lock mechanisms and penalties to punish newcomers who plan to dump the token as soon they receive it.

Our number one priority will always be to protect the value of our token and ensure Penguins’ wealth continues to grow alongside the project.

How and Where to Buy PEFI token?

PEFI 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 PEFI 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.

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

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 PEFI is an altcoin we need to transfer our coins to an exchange that PEFI can be traded. Below is a list of exchanges that offers to trade PEFI 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/BNB deposit to the exchange from Binance depending on the available market pairs. After the deposit is confirmed you may then purchase PEFI from the exchange.

The top exchange for trading in PEFI token is currently PEFI

Find more information PEFI

WebsiteWebsite 2ExplorerSource CodeSocial ChannelSocial Channel 2Social Channel 3Message BoardDocumentationCoinmarketcap

🔺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

⭐ ⭐ ⭐The project is of interest to the community. Join to Get free ‘GEEK coin’ (GEEKCASH coin)!

☞ **-----https://geekcash.org-----**⭐ ⭐ ⭐

Thank for visiting and reading this article! Please don’t forget to leave a like, comment and share!

#blockchain #bitcoin #pefi #penguin finance

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