plancraft 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

plancraft/environments/sampler.py

@@ -0,0 +1,224 @@
+import math
+import random
+from collections import Counter
+
+import numpy as np
+from plancraft.environments.items import all_data, ALL_ITEMS
+from plancraft.environments.recipes import RECIPES
+from plancraft.environments.planner import optimal_planner, get_ancestors
+
+
+MAX_STACK_SIZE = {}
+for data_item in all_data["items"]:
+    if data_item["stackable"]:
+        MAX_STACK_SIZE[data_item["type"]] = data_item["stackSize"]
+    else:
+        MAX_STACK_SIZE[data_item["type"]] = 1
+
+
+def sample_distractors(
+    exclude_set: set = None, num_distractors: int = 16
+) -> dict[str, int]:
+    distractors = {}
+    while len(distractors) < num_distractors:
+        item = random.choice(ALL_ITEMS)
+        if exclude_set is not None and item in exclude_set:
+            continue
+        count = random.randint(1, MAX_STACK_SIZE[item])
+        distractors[item] = count
+    return distractors
+
+
+def assign_to_slots(inventory: dict[str, int]) -> list[dict]:
+    # slots available outside of crafting interface
+    available_slots = list(range(10, 46))
+    random.shuffle(available_slots)
+    inventory_list = []
+
+    for item, total_count in inventory.items():
+        while total_count > 0:
+            if len(available_slots) == 0:
+                print("Not enough slots available")
+                break
+            slot = available_slots.pop()
+            count_in_slot = min(total_count, MAX_STACK_SIZE[item])
+            inventory_list.append({"slot": slot, "item": item, "count": count_in_slot})
+            total_count -= count_in_slot
+
+    return inventory_list
+
+
+def sample_recipes(
+    target: str,
+    overall_exclude_set: set,
+    target_count: int = 1,
+    current_depth=0,
+    max_depth=20,
+) -> tuple[set, set]:
+    # stop if the depth is too high
+    if current_depth > max_depth:
+        return {}, overall_exclude_set
+
+    # get all the recipes that can craft the target
+    overall_exclude_set.update([target])
+    local_exclude_set = set()
+    random_recipes = []
+    for r in RECIPES[target]:
+        recipe_inputs, exclude_set = r.sample_inputs()
+        # if inputs are already in the exclude set, skip this recipe (ensures no cycle)
+        if exclude_set.intersection(overall_exclude_set):
+            return {}, overall_exclude_set
+        local_exclude_set.update(exclude_set)
+        random_recipes.append((r, recipe_inputs))
+
+    overall_exclude_set |= local_exclude_set
+
+    # no recipes found
+    if len(random_recipes) == 0:
+        return {}, overall_exclude_set
+
+    # sample a random recipe
+    random_recipe = random.choice(random_recipes)
+    recipe, start_inputs = random_recipe
+
+    # recipe will not produce enough
+    if recipe.result.count < target_count:
+        # must do recipe X times
+        recipe_multiplier = math.ceil(target_count / recipe.result.count)
+        start_inputs = {k: v * recipe_multiplier for k, v in start_inputs.items()}
+
+    for input_item in list(start_inputs.keys()):
+        # randomize depth first search to end early
+        if random.choice([True, False]):
+            continue
+
+        children_recipe_inputs, updated_exclude_set = sample_recipes(
+            target=input_item,
+            overall_exclude_set=overall_exclude_set,
+            target_count=start_inputs[input_item],
+            current_depth=current_depth + 1,
+        )
+        if len(children_recipe_inputs) == 0:
+            continue
+
+        overall_exclude_set.update(updated_exclude_set)
+
+        # remove recipe input item since we are crafting it
+        start_inputs[input_item] = 0
+
+        # add the children recipe inputs
+        for item, count in children_recipe_inputs.items():
+            start_inputs[item] = start_inputs.get(item, 0) + count
+
+    overall_exclude_set = overall_exclude_set - {None}
+    start_inputs = {k: v for k, v in start_inputs.items() if v > 0}
+
+    return start_inputs, overall_exclude_set
+
+
+def remove_ancestor_items(target: str, inventory: dict[str, int]) -> dict[str, int]:
+    ancestors = set(get_ancestors(target))
+    possible_items = set(inventory.keys())
+    items_to_remove = list(ancestors.intersection(possible_items))
+    num_items = random.randint(1, len(items_to_remove))
+    for item in random.sample(items_to_remove, num_items):
+        count_to_remove = random.randint(1, inventory[item])
+        inventory[item] -= count_to_remove
+        if inventory[item] == 0:
+            del inventory[item]
+    return inventory
+
+
+def construct_example(
+    target: str,
+    num_distractors: 16,
+    impossible=False,
+) -> list[dict]:
+    """
+    For a given target object, number of distractors, and impossible flag
+    Return a dictionary with the start inventory for the crafting task
+
+    The crafting task should be to craft the target, the inventory should contain
+    the resources required for the recipe to be crafted.
+
+    The number of distractors are how many random items should be added to the inventory.
+
+    If impossible is True, the target item should not be craftable with the given inventory.
+    """
+
+    # sample the recipe
+    inventory, overall_exclude_set = sample_recipes(target, set())
+    if impossible:
+        # if impossible then remove one or more items from the inventory
+        inventory = remove_ancestor_items(
+            target,
+            inventory,
+        )
+
+    # add distractors to the inventory
+    distractors = sample_distractors(overall_exclude_set, num_distractors)
+    inventory.update(distractors)
+
+    optimal_path = optimal_planner(target, inventory)
+    # @TODO this is a hack to ensure that we don't have impossible examples
+    while optimal_path is not None and impossible:
+        inventory = remove_ancestor_items(target, inventory)
+        optimal_path = optimal_planner(target, inventory)
+
+    # assign to slots
+    inventory_list = assign_to_slots(inventory)
+    example = {
+        "inventory": inventory,
+        "slotted_inventory": inventory_list,
+        "target": target,
+        "num_distractors": num_distractors,
+        "impossible": impossible,
+    }
+    # either impossible and no path or not impossible and path exists
+    assert (impossible and optimal_path is None) or (
+        not impossible and optimal_path is not None
+    )
+
+    if not impossible:
+        example["optimal_path_length"] = len(optimal_path)
+        example["optimal_path"] = [r.result.item for (r, i) in optimal_path]
+        example["inventory_trace"] = [i for (r, i) in optimal_path]
+        items_used, unique_items_used = calculate_stats_from_inventory_trace(
+            [example["inventory"]] + example["inventory_trace"]
+        )
+        example["items_used"] = items_used
+        example["unique_items_used"] = unique_items_used
+
+    return example
+
+
+def calculate_stats_from_inventory_trace(
+    inventory_trace: list[dict],
+) -> tuple[int, int]:
+    total_items_used = 0
+    total_unique_items_used = 0
+
+    for a, b in zip(inventory_trace[:-1], inventory_trace[1:]):
+        diff = Counter(a) - Counter(b)
+        total_items_used += sum(diff.values())
+        total_unique_items_used += len(diff)
+
+    return total_items_used, total_unique_items_used
+
+
+def generate_dataset(seed=2024, distractors=[4, 8, 16], num_examples=10):
+    random.seed(seed)
+    np.random.seed(seed)
+
+    dataset = []
+    for recipe_target in list(RECIPES.keys()):
+        if len(RECIPES[recipe_target]) == 0:
+            continue
+        for num_distractors in distractors:
+            for _ in range(num_examples):
+                example = construct_example(
+                    target=recipe_target, num_distractors=num_distractors
+                )
+                dataset.append(example)
+
+    return dataset

plancraft/environments/tags/acacia_logs.json

@@ -0,0 +1,9 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:acacia_log",
+    "minecraft:acacia_wood",
+    "minecraft:stripped_acacia_log",
+    "minecraft:stripped_acacia_wood"
+  ]
+}

plancraft/environments/tags/anvil.json

@@ -0,0 +1,8 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:anvil",
+    "minecraft:chipped_anvil",
+    "minecraft:damaged_anvil"
+  ]
+}

plancraft/environments/tags/arrows.json

@@ -0,0 +1,8 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:arrow",
+    "minecraft:tipped_arrow",
+    "minecraft:spectral_arrow"
+  ]
+}

plancraft/environments/tags/banners.json

@@ -0,0 +1,21 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:white_banner",
+    "minecraft:orange_banner",
+    "minecraft:magenta_banner",
+    "minecraft:light_blue_banner",
+    "minecraft:yellow_banner",
+    "minecraft:lime_banner",
+    "minecraft:pink_banner",
+    "minecraft:gray_banner",
+    "minecraft:light_gray_banner",
+    "minecraft:cyan_banner",
+    "minecraft:purple_banner",
+    "minecraft:blue_banner",
+    "minecraft:brown_banner",
+    "minecraft:green_banner",
+    "minecraft:red_banner",
+    "minecraft:black_banner"
+  ]
+}

plancraft/environments/tags/beacon_payment_items.json

@@ -0,0 +1,10 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:netherite_ingot",
+    "minecraft:emerald",
+    "minecraft:diamond",
+    "minecraft:gold_ingot",
+    "minecraft:iron_ingot"
+  ]
+}

plancraft/environments/tags/beds.json

@@ -0,0 +1,21 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:red_bed",
+    "minecraft:black_bed",
+    "minecraft:blue_bed",
+    "minecraft:brown_bed",
+    "minecraft:cyan_bed",
+    "minecraft:gray_bed",
+    "minecraft:green_bed",
+    "minecraft:light_blue_bed",
+    "minecraft:light_gray_bed",
+    "minecraft:lime_bed",
+    "minecraft:magenta_bed",
+    "minecraft:orange_bed",
+    "minecraft:pink_bed",
+    "minecraft:purple_bed",
+    "minecraft:white_bed",
+    "minecraft:yellow_bed"
+  ]
+}

plancraft/environments/tags/birch_logs.json

@@ -0,0 +1,9 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:birch_log",
+    "minecraft:birch_wood",
+    "minecraft:stripped_birch_log",
+    "minecraft:stripped_birch_wood"
+  ]
+}

plancraft/environments/tags/boats.json

@@ -0,0 +1,11 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:oak_boat",
+    "minecraft:spruce_boat",
+    "minecraft:birch_boat",
+    "minecraft:jungle_boat",
+    "minecraft:acacia_boat",
+    "minecraft:dark_oak_boat"
+  ]
+}

plancraft/environments/tags/buttons.json

@@ -0,0 +1,8 @@
+{
+  "replace": false,
+  "values": [
+    "#minecraft:wooden_buttons",
+    "minecraft:stone_button",
+    "minecraft:polished_blackstone_button"
+  ]
+}

plancraft/environments/tags/carpets.json

@@ -0,0 +1,21 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:white_carpet",
+    "minecraft:orange_carpet",
+    "minecraft:magenta_carpet",
+    "minecraft:light_blue_carpet",
+    "minecraft:yellow_carpet",
+    "minecraft:lime_carpet",
+    "minecraft:pink_carpet",
+    "minecraft:gray_carpet",
+    "minecraft:light_gray_carpet",
+    "minecraft:cyan_carpet",
+    "minecraft:purple_carpet",
+    "minecraft:blue_carpet",
+    "minecraft:brown_carpet",
+    "minecraft:green_carpet",
+    "minecraft:red_carpet",
+    "minecraft:black_carpet"
+  ]
+}

plancraft/environments/tags/coals.json

@@ -0,0 +1,7 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:coal",
+    "minecraft:charcoal"
+  ]
+}

plancraft/environments/tags/creeper_drop_music_discs.json

@@ -0,0 +1,17 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:music_disc_13",
+    "minecraft:music_disc_cat",
+    "minecraft:music_disc_blocks",
+    "minecraft:music_disc_chirp",
+    "minecraft:music_disc_far",
+    "minecraft:music_disc_mall",
+    "minecraft:music_disc_mellohi",
+    "minecraft:music_disc_stal",
+    "minecraft:music_disc_strad",
+    "minecraft:music_disc_ward",
+    "minecraft:music_disc_11",
+    "minecraft:music_disc_wait"
+  ]
+}

plancraft/environments/tags/crimson_stems.json

@@ -0,0 +1,9 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:crimson_stem",
+    "minecraft:stripped_crimson_stem",
+    "minecraft:crimson_hyphae",
+    "minecraft:stripped_crimson_hyphae"
+  ]
+}

plancraft/environments/tags/dark_oak_logs.json

@@ -0,0 +1,9 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:dark_oak_log",
+    "minecraft:dark_oak_wood",
+    "minecraft:stripped_dark_oak_log",
+    "minecraft:stripped_dark_oak_wood"
+  ]
+}

plancraft/environments/tags/doors.json

@@ -0,0 +1,7 @@
+{
+  "replace": false,
+  "values": [
+    "#minecraft:wooden_doors",
+    "minecraft:iron_door"
+  ]
+}

plancraft/environments/tags/fences.json

@@ -0,0 +1,7 @@
+{
+  "replace": false,
+  "values": [
+    "#minecraft:wooden_fences",
+    "minecraft:nether_brick_fence"
+  ]
+}

plancraft/environments/tags/fishes.json

@@ -0,0 +1,11 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:cod",
+    "minecraft:cooked_cod",
+    "minecraft:salmon",
+    "minecraft:cooked_salmon",
+    "minecraft:pufferfish",
+    "minecraft:tropical_fish"
+  ]
+}

plancraft/environments/tags/flowers.json

@@ -0,0 +1,7 @@
+{
+  "replace": false,
+  "values": [
+    "#minecraft:small_flowers",
+    "#minecraft:tall_flowers"
+  ]
+}

plancraft/environments/tags/gold_ores.json

@@ -0,0 +1,7 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:gold_ore",
+    "minecraft:nether_gold_ore"
+  ]
+}

plancraft/environments/tags/jungle_logs.json

@@ -0,0 +1,9 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:jungle_log",
+    "minecraft:jungle_wood",
+    "minecraft:stripped_jungle_log",
+    "minecraft:stripped_jungle_wood"
+  ]
+}

plancraft/environments/tags/leaves.json

@@ -0,0 +1,11 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:jungle_leaves",
+    "minecraft:oak_leaves",
+    "minecraft:spruce_leaves",
+    "minecraft:dark_oak_leaves",
+    "minecraft:acacia_leaves",
+    "minecraft:birch_leaves"
+  ]
+}

plancraft/environments/tags/lectern_books.json

@@ -0,0 +1,7 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:written_book",
+    "minecraft:writable_book"
+  ]
+}

plancraft/environments/tags/logs.json

@@ -0,0 +1,8 @@
+{
+  "replace": false,
+  "values": [
+    "#minecraft:logs_that_burn",
+    "#minecraft:crimson_stems",
+    "#minecraft:warped_stems"
+  ]
+}

plancraft/environments/tags/logs_that_burn.json

@@ -0,0 +1,11 @@
+{
+  "replace": false,
+  "values": [
+    "#minecraft:dark_oak_logs",
+    "#minecraft:oak_logs",
+    "#minecraft:acacia_logs",
+    "#minecraft:birch_logs",
+    "#minecraft:jungle_logs",
+    "#minecraft:spruce_logs"
+  ]
+}

plancraft/environments/tags/music_discs.json

@@ -0,0 +1,7 @@
+{
+  "replace": false,
+  "values": [
+    "#minecraft:creeper_drop_music_discs",
+    "minecraft:music_disc_pigstep"
+  ]
+}

plancraft/environments/tags/non_flammable_wood.json

@@ -0,0 +1,33 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:warped_stem",
+    "minecraft:stripped_warped_stem",
+    "minecraft:warped_hyphae",
+    "minecraft:stripped_warped_hyphae",
+    "minecraft:crimson_stem",
+    "minecraft:stripped_crimson_stem",
+    "minecraft:crimson_hyphae",
+    "minecraft:stripped_crimson_hyphae",
+    "minecraft:crimson_planks",
+    "minecraft:warped_planks",
+    "minecraft:crimson_slab",
+    "minecraft:warped_slab",
+    "minecraft:crimson_pressure_plate",
+    "minecraft:warped_pressure_plate",
+    "minecraft:crimson_fence",
+    "minecraft:warped_fence",
+    "minecraft:crimson_trapdoor",
+    "minecraft:warped_trapdoor",
+    "minecraft:crimson_fence_gate",
+    "minecraft:warped_fence_gate",
+    "minecraft:crimson_stairs",
+    "minecraft:warped_stairs",
+    "minecraft:crimson_button",
+    "minecraft:warped_button",
+    "minecraft:crimson_door",
+    "minecraft:warped_door",
+    "minecraft:crimson_sign",
+    "minecraft:warped_sign"
+  ]
+}

plancraft/environments/tags/oak_logs.json

@@ -0,0 +1,9 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:oak_log",
+    "minecraft:oak_wood",
+    "minecraft:stripped_oak_log",
+    "minecraft:stripped_oak_wood"
+  ]
+}

plancraft/environments/tags/piglin_loved.json

@@ -0,0 +1,26 @@
+{
+  "replace": false,
+  "values": [
+    "#minecraft:gold_ores",
+    "minecraft:gold_block",
+    "minecraft:gilded_blackstone",
+    "minecraft:light_weighted_pressure_plate",
+    "minecraft:gold_ingot",
+    "minecraft:bell",
+    "minecraft:clock",
+    "minecraft:golden_carrot",
+    "minecraft:glistering_melon_slice",
+    "minecraft:golden_apple",
+    "minecraft:enchanted_golden_apple",
+    "minecraft:golden_helmet",
+    "minecraft:golden_chestplate",
+    "minecraft:golden_leggings",
+    "minecraft:golden_boots",
+    "minecraft:golden_horse_armor",
+    "minecraft:golden_sword",
+    "minecraft:golden_pickaxe",
+    "minecraft:golden_shovel",
+    "minecraft:golden_axe",
+    "minecraft:golden_hoe"
+  ]
+}

plancraft/environments/tags/piglin_repellents.json

@@ -0,0 +1,8 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:soul_torch",
+    "minecraft:soul_lantern",
+    "minecraft:soul_campfire"
+  ]
+}

plancraft/environments/tags/planks.json

@@ -0,0 +1,13 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:oak_planks",
+    "minecraft:spruce_planks",
+    "minecraft:birch_planks",
+    "minecraft:jungle_planks",
+    "minecraft:acacia_planks",
+    "minecraft:dark_oak_planks",
+    "minecraft:crimson_planks",
+    "minecraft:warped_planks"
+  ]
+}

plancraft/environments/tags/rails.json

@@ -0,0 +1,9 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:rail",
+    "minecraft:powered_rail",
+    "minecraft:detector_rail",
+    "minecraft:activator_rail"
+  ]
+}

plancraft/environments/tags/sand.json

@@ -0,0 +1,7 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:sand",
+    "minecraft:red_sand"
+  ]
+}

plancraft/environments/tags/saplings.json

@@ -0,0 +1,11 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:oak_sapling",
+    "minecraft:spruce_sapling",
+    "minecraft:birch_sapling",
+    "minecraft:jungle_sapling",
+    "minecraft:acacia_sapling",
+    "minecraft:dark_oak_sapling"
+  ]
+}

plancraft/environments/tags/signs.json

@@ -0,0 +1,13 @@
+{
+  "replace": false,
+  "values": [
+    "minecraft:oak_sign",
+    "minecraft:spruce_sign",
+    "minecraft:birch_sign",
+    "minecraft:acacia_sign",
+    "minecraft:jungle_sign",
+    "minecraft:dark_oak_sign",
+    "minecraft:crimson_sign",
+    "minecraft:warped_sign"
+  ]
+}