metadata.rarity

Command Line

usage: rarity.py [-h] [--collection COLLECTION] [--method METHOD]
                 [--trait_count TRAIT_COUNT]
                 [--sum_traits SUM_TRAITS [SUM_TRAITS ...]]
                 [--sum_trait_multiplier SUM_TRAIT_MULTIPLIER]

-h, --help

show this help message and exit

--collection <collection>

Collection name.

--method <method>

Method to use to compute rarity. (default: raritytools)

--trait_count <trait_count>

Toggle using trait count in computation. (default: True)

--sum_traits <sum_traits>

Traits to sum instead of computing rarity. Can be one or many. (default: None)

--sum_trait_multiplier <sum_trait_multiplier>

Trait score multiplier to use for summed traits. (default: 35)

---

Internal functions

metadata.rarity.max_variety_count(trait_db, trait_types)

Parameters

• trait_db (DataFrame) –

• trait_types (list) –

Return type

int

metadata.rarity.gen_rarity_score(trait_db, trait_types, method, trait_count, sum_traits, sum_trait_multiplier)

Parameters

• trait_db (DataFrame) –

• trait_types (list) –

• method (str) –

• trait_count (bool) –

• sum_traits (list) –

• sum_trait_multiplier (int) –

Return type

DataFrame

metadata.rarity.build_rarity_db(collection, attribute_file, method, trait_count, sum_traits, sum_trait_multiplier)

Parameters

• collection (str) –

• attribute_file (str) –

• method (str) –

• trait_count (bool) –

• sum_traits (list) –

• sum_trait_multiplier (int) –

Return type

None