What is Magikarp Finance (GYA) | What is Magikarp Finance token | What is GYA token

In this article, we’ll discuss information about the Magikarp Finance project and GYA token

This project hatched from the idea to include the community as a core part of a project while adding fun mechanics. The community will be included and take part in the future of Magikarp, can participate in big decisions through voting system in our telegram group, and contribute with innovative ideas (some crazy ones we’ve heard); Magikarp motto: we shall be honest and crystal clear.

How Does it Work ?

Magikarp ($MAGI) is a RFI token, which means that, with every transaction made, there will be a % of the value splashing back to all holders and a % that will be burned.

The maximum percentage for this purpose is 9% (hardcoded, safu).

Currently the distribution burn fee is set to 6% distribution / 3% burn.

In the near future there will Community Votes to decide how to readjust this ratio (i.e.: 6% burn and 3% shared, or 4.5% burn — 4.5% shared). This is the Normal Fee Mode.

In the first week, we will release the Storm Mode, which is a different type of tax mode, we don’t want to reveal too much but know that the max cap will still only be 9%. **More information will be published **in an upcoming medium post and there will be a 24h notice before it goes into effect.

Are your Tokens SAFU?

Long story short, yes.

We have some experience with previous BSC projects and from the launch, we decided we wanted to be as secure as possible.

For this purpose, we use the Gnosis Safe on BSC, meaning that, if someone is planning on moving the funds the team wallets (there are 2), multiple team members must authorize it. Both received 10% from the initial supply. We aim to distribute these funds for the prosperity of this project.

The team members all know each other. We had an internal KYC 😉

In addition 2 of our 3 Core Team Members have doxxed themselves to @DeFiDownsin (unrelated to the project).

The above described measure ensure the safety of the project.

This project is still experimental, please only but in what you are comfortable with. This is still DeFi and we want everyone to be safe. This means calculated risks and DYOR.

The GYA Yield Farming Guide

GYA is the inflationary token of Magikarp’s Finance ecosystem. There are 3 ways to earn via GYA with yield farming. Each of these ways of yield farming carry their own sets of risks and rewards, tailored for your risk appetite. Understand the mechanics of each method, so you can come up with your own strategies to maximize your profits with our system. As usual, we provide the transparency and information so you can DYOR and capitalize on gains in the crypto world!

Aqua Farms

Aqua farms work by providing liquidity to trading pairs. When you provide liquidity to a liquidity pool, you receive LP tokens. You earn in 2 ways through this method: your LP tokens help you to earn via trading fees for helping to provide the liquidity in that trading pair, while at the same time, you are rewarded with GYA for your contributions to the ecosystem.

  1. Hold equal values of GYA and BUSD.
  2. Head over to  https://exchange.pancakeswap.finance/#/pool to add your liquidity
  3. Select GYA as one of the tokens, and BUSD as the other token. PancakeSwap will ensure you have equal values of each token you are adding to the LP.
  4. Click supply to get your GYA-BUSD LP tokens in return for providing GYA and BUSD liquidity to the pool
  5. Take your LP tokens to  https://farm.magikarp.finance/farms, approve the contract if you haven’t already, and deposit your GYA-BUSD LP tokens.
  6. Watch your GYA rewards grow!

Yes, it’s that simple! Do take note that there are costs to farms, though. Each LP farm has their own deposit fee, and if any, the fee is taken off your deposit and sent to the dev wallets for GYA buyback and marketing. There is also a 9.09% GYA fee when unstaking. These are necessary fees to ensure that the ecosystem remains sustainable — without such measures, there would be an oversupply of GYA in the market, which negatively impacts prices. Therefore, it is critical that you plan your investment and staking such that the rewards surpass the fees incurred!

Swimming Pools

Earning from swimming pools is much more straightforward. All you have to do is to:

  1. Hold sufficient GYA
  2. Head over to  https://farm.magikarp.finance/pools
  3. Stake your GYA to earn GYA rewards

Once again, take note that there is a deposit fee incurred on staking. There is also a fee taxed on the rewards when withdrawing, and these 2 fees are sent to the dev wallets to be used for GYA buyback and marketing purposes.

Shrines

Shrines are the latest features of the Magikarp ecosystem. This is a concept that has never been done before, and we’re proud to be bringing it to the Magikarp community. In shrines, you earn your rewards in MAGI or BNB. This reward pool is exhaustive, and is initial filled by the dev. This comes with a cost — there is a** 99% unstaking fee**, which means you are essentially sacrificing GYA for crazy rewards. This 99% fee, however, is subject to tweaking, as this concept is experimental. It will be lowered manually when the supply of GYA is low, and increased back to a max of 99% when there is an oversupply of GYA in the market.

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

How and Where to Buy Magikarp Finance (GYA)?

Magikarp Finance is now live on the Binance mainnet. The token address for GYA is 0x9458784486fb00c2d1a8740d5579207c42dbd602. Be cautious not to purchase any other token with a smart contract different from this one (as this can be easily faked). We strongly advise to be vigilant and stay safe throughout the launch. Don’t let the excitement get the best of you.

Just be sure you have enough BNB in your wallet to cover the transaction fees.

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 2021)

Next step

You need a wallet address to Connect to Uniswap Decentralized Exchange, we use Metamask wallet

If you don’t have a Metamask wallet, read this article and follow the steps
What is Metamask wallet | How to Create a wallet and Use

Next step

Connect Metamask Wallet to Pancakeswap Decentralized Exchange and Buy GYA token

Contract: 0x9458784486fb00c2d1a8740d5579207c42dbd602

Read more: What is Pancakeswap | Beginner’s Guide on How to Use Pancakeswap

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 GYA 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.binance.com
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 GYA

WebsiteExplorerSocial ChannelSocial Channel 2Message BoardCoinmarketcap

🔺DISCLAIMER: The Information in the post is my OPINION and not 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 ⭐ ⭐ ⭐

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

#bitcoin #crypto #gya #magikarp finance

What is GEEK

Buddha Community

What is Magikarp Finance (GYA) | What is Magikarp Finance token | What is GYA token

What is Magikarp Finance (GYA) | What is Magikarp Finance token | What is GYA token

In this article, we’ll discuss information about the Magikarp Finance project and GYA token

This project hatched from the idea to include the community as a core part of a project while adding fun mechanics. The community will be included and take part in the future of Magikarp, can participate in big decisions through voting system in our telegram group, and contribute with innovative ideas (some crazy ones we’ve heard); Magikarp motto: we shall be honest and crystal clear.

How Does it Work ?

Magikarp ($MAGI) is a RFI token, which means that, with every transaction made, there will be a % of the value splashing back to all holders and a % that will be burned.

The maximum percentage for this purpose is 9% (hardcoded, safu).

Currently the distribution burn fee is set to 6% distribution / 3% burn.

In the near future there will Community Votes to decide how to readjust this ratio (i.e.: 6% burn and 3% shared, or 4.5% burn — 4.5% shared). This is the Normal Fee Mode.

In the first week, we will release the Storm Mode, which is a different type of tax mode, we don’t want to reveal too much but know that the max cap will still only be 9%. **More information will be published **in an upcoming medium post and there will be a 24h notice before it goes into effect.

Are your Tokens SAFU?

Long story short, yes.

We have some experience with previous BSC projects and from the launch, we decided we wanted to be as secure as possible.

For this purpose, we use the Gnosis Safe on BSC, meaning that, if someone is planning on moving the funds the team wallets (there are 2), multiple team members must authorize it. Both received 10% from the initial supply. We aim to distribute these funds for the prosperity of this project.

The team members all know each other. We had an internal KYC 😉

In addition 2 of our 3 Core Team Members have doxxed themselves to @DeFiDownsin (unrelated to the project).

The above described measure ensure the safety of the project.

This project is still experimental, please only but in what you are comfortable with. This is still DeFi and we want everyone to be safe. This means calculated risks and DYOR.

The GYA Yield Farming Guide

GYA is the inflationary token of Magikarp’s Finance ecosystem. There are 3 ways to earn via GYA with yield farming. Each of these ways of yield farming carry their own sets of risks and rewards, tailored for your risk appetite. Understand the mechanics of each method, so you can come up with your own strategies to maximize your profits with our system. As usual, we provide the transparency and information so you can DYOR and capitalize on gains in the crypto world!

Aqua Farms

Aqua farms work by providing liquidity to trading pairs. When you provide liquidity to a liquidity pool, you receive LP tokens. You earn in 2 ways through this method: your LP tokens help you to earn via trading fees for helping to provide the liquidity in that trading pair, while at the same time, you are rewarded with GYA for your contributions to the ecosystem.

  1. Hold equal values of GYA and BUSD.
  2. Head over to  https://exchange.pancakeswap.finance/#/pool to add your liquidity
  3. Select GYA as one of the tokens, and BUSD as the other token. PancakeSwap will ensure you have equal values of each token you are adding to the LP.
  4. Click supply to get your GYA-BUSD LP tokens in return for providing GYA and BUSD liquidity to the pool
  5. Take your LP tokens to  https://farm.magikarp.finance/farms, approve the contract if you haven’t already, and deposit your GYA-BUSD LP tokens.
  6. Watch your GYA rewards grow!

Yes, it’s that simple! Do take note that there are costs to farms, though. Each LP farm has their own deposit fee, and if any, the fee is taken off your deposit and sent to the dev wallets for GYA buyback and marketing. There is also a 9.09% GYA fee when unstaking. These are necessary fees to ensure that the ecosystem remains sustainable — without such measures, there would be an oversupply of GYA in the market, which negatively impacts prices. Therefore, it is critical that you plan your investment and staking such that the rewards surpass the fees incurred!

Swimming Pools

Earning from swimming pools is much more straightforward. All you have to do is to:

  1. Hold sufficient GYA
  2. Head over to  https://farm.magikarp.finance/pools
  3. Stake your GYA to earn GYA rewards

Once again, take note that there is a deposit fee incurred on staking. There is also a fee taxed on the rewards when withdrawing, and these 2 fees are sent to the dev wallets to be used for GYA buyback and marketing purposes.

Shrines

Shrines are the latest features of the Magikarp ecosystem. This is a concept that has never been done before, and we’re proud to be bringing it to the Magikarp community. In shrines, you earn your rewards in MAGI or BNB. This reward pool is exhaustive, and is initial filled by the dev. This comes with a cost — there is a** 99% unstaking fee**, which means you are essentially sacrificing GYA for crazy rewards. This 99% fee, however, is subject to tweaking, as this concept is experimental. It will be lowered manually when the supply of GYA is low, and increased back to a max of 99% when there is an oversupply of GYA in the market.

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

How and Where to Buy Magikarp Finance (GYA)?

Magikarp Finance is now live on the Binance mainnet. The token address for GYA is 0x9458784486fb00c2d1a8740d5579207c42dbd602. Be cautious not to purchase any other token with a smart contract different from this one (as this can be easily faked). We strongly advise to be vigilant and stay safe throughout the launch. Don’t let the excitement get the best of you.

Just be sure you have enough BNB in your wallet to cover the transaction fees.

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 2021)

Next step

You need a wallet address to Connect to Uniswap Decentralized Exchange, we use Metamask wallet

If you don’t have a Metamask wallet, read this article and follow the steps
What is Metamask wallet | How to Create a wallet and Use

Next step

Connect Metamask Wallet to Pancakeswap Decentralized Exchange and Buy GYA token

Contract: 0x9458784486fb00c2d1a8740d5579207c42dbd602

Read more: What is Pancakeswap | Beginner’s Guide on How to Use Pancakeswap

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 GYA 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.binance.com
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 GYA

WebsiteExplorerSocial ChannelSocial Channel 2Message BoardCoinmarketcap

🔺DISCLAIMER: The Information in the post is my OPINION and not 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 ⭐ ⭐ ⭐

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

#bitcoin #crypto #gya #magikarp 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