Ivy Container Class

<p>ivy.Container = Special method for the add operator ivy.Array = Instances at the leaves operator.add = Called for each of the corresponding leaves of the two containers ivy.Container and ivy.Array = Mix of instances at the leaves</p> Signup and view all the answers

<p>ivy.Container = Uses a special method for the add operator ivy.Array = Used in instances at the leaves ivy.Container and ivy.Array = Used in a mix of instances</p> Signup and view all the answers

<p>ivy.Container = Defines a special method for the add operator ivy.Array = Can be an instance at the leaves operator.add = Called during the operation of the add operator</p> Signup and view all the answers

<p>build_callable</p> Signup and view all the answers

<p>cont_identical_array_shapes</p> Signup and view all the answers

<p>check_types</p> Signup and view all the answers

<p>cont_inplace_update</p> Signup and view all the answers

<p>cont_from_disk_as_json</p> Signup and view all the answers

<p>json_filepath</p> Signup and view all the answers

<p>alphabetical_keys</p> Signup and view all the answers

<p>cont_has_key</p> Signup and view all the answers

<p>print_limit</p> Signup and view all the answers

<p>'green'</p> Signup and view all the answers

<p>Whether to rebuild container found in dict_in with these constructor params</p> Signup and view all the answers

<p>Whether to sort the container keys alphabetically, or preserve the dict order</p> Signup and view all the answers

<p>to_apply</p> Signup and view all the answers

<p>False</p> Signup and view all the answers

<p>Asserts that the current container contains the sub-container structure</p> Signup and view all the answers

<p>Queries container object at a specified key-chain</p> Signup and view all the answers

<p>ignore_key_errors</p> Signup and view all the answers

<p>list of key-chains</p> Signup and view all the answers

<p>whether the current container contains the sub-container, with matching structure and array values</p> Signup and view all the answers

<p>compares keys and values in a sequence of containers</p> Signup and view all the answers

<p>to_apply</p> Signup and view all the answers

<p>Whether to prune key chains for which the function was not applied</p> Signup and view all the answers

<p>Whether to apply the mapping inplace or return a new container</p> Signup and view all the answers

<p>Whether to include the self container</p> Signup and view all the answers

<p>The configuration settings for the mapping</p> Signup and view all the answers

<p>Whether the array values from the containers should be identical</p> Signup and view all the answers

<p>ABC</p> Signup and view all the answers

<p><strong>getitem</strong></p> Signup and view all the answers

<p>cont_list_join</p> Signup and view all the answers

<p>To enable the current container to be passed around asynchronously while waiting for data.</p> Signup and view all the answers

<p>dict_in = The dictionary the container should wrap around. queues = Sequence of multiprocessing queues, each of which returns containers. container_combine_method = The method to use for combining containers arriving from different queues. queue_timeout = The timeout when waiting for containers to arrive from the queues.</p> Signup and view all the answers

<p><strong>getitem</strong>(query) = Get slice, key or key chain of container object. <strong>init</strong> = Initialize container object from input dict representation.</p> Signup and view all the answers

<p>dict_in = None queues = None queue_load_sizes = None container_combine_method = 'list_join'</p> Signup and view all the answers

<p>dict_in = dictionary queues = Sequence print_limit = integer container_combine_method = string</p> Signup and view all the answers

<p>print_limit = 10 key_length_limit = None print_indent = 4 print_line_spacing = 0</p> Signup and view all the answers

<p>ivyh = Handle to ivy module to use for the calculations. rebuild_child_containers = Whether to rebuild container found in dict_in with these constructor params. alphabetical_keys = Whether to sort the container keys alphabetically, or preserve the dict order. kwargs = keyword arguments for dict creation.</p> Signup and view all the answers

<p>_cont_call_static_method_with_flexible_args = Container _cont_get_dev = device _cont_get_shape = shape _cont_get_shapes = shapes</p> Signup and view all the answers

<p>cont_all_false = Determine whether all the entries in the container boolean evaluate to False. cont_all_key_chains = Returns all key chains in the container. cont_all_true = Determine whether all the entries in the container boolean evaluate to True. cont_as_bools = Return boolean evaluation for all nested items in the container.</p> Signup and view all the answers

<p>cont_flatten_key_chain = Flattens the key chain with a specified replacement string cont_from_disk_as_hdf5 = Loads a container object from disk as an h5py file cont_has_key = Determines whether a container object has a specified key cont_identical = Checks whether input containers have identical key-chains and data types</p> Signup and view all the answers

<p>replacement = Specifies the string to replace in the key chain above_height = Determines the height above which the function should not operate include_empty = Includes empty objects if set to True check_shapes = Checks whether the shapes of the leaf nodes are the same</p> Signup and view all the answers

<p>cont_from_disk_as_json = Returns a container object loaded from a JSON file cont_has_key = Returns a boolean indicating whether the container has a specified key cont_identical = Returns a boolean indicating whether the containers have identical key-chains and data types cont_flatten_key_chain = Returns a flattened key chain</p> Signup and view all the answers

<p>above_height = None replacement = '__' include_empty = False ivyh = None</p> Signup and view all the answers

<p>cont_assert_contains_sub_container = Asserts that the current container contains the sub-container, otherwise exception raised with the diff printed to screen. cont_assert_identical = Asserts whether the input containers are identical. Otherwise, the diff is shown in an exception. cont_at_key_chain = Queries container object at a specified key-chain. cont_at_keys = Queries container object at specified keys, either as list or nested dict.</p> Signup and view all the answers

<p>key_chains = None to_apply = True prune_unapplied = False map_sequences = False</p> Signup and view all the answers

<p>check_shapes = Whether to check if the shapes of the leaf nodes are the same. same_arrays = Whether to check if the arrays are the exact same instances. arrays_equal = Whether to check if the arrays have equal values. partial = Whether to also check for partially complete sub-containers.</p> Signup and view all the answers

<p>cont_assert_identical_structure = containers, check_types, check_shapes, key_chains, to_apply, partial, build_callable, assert_and_assign cont_assert_identical = containers, check_types, check_shapes, same_arrays, arrays_equal, key_chains, to_apply, partial cont_at_key_chain = key_chain, ignore_key_errors cont_at_keys = queries, ignore_none, containing, ignore_key_errors</p> Signup and view all the answers

<p>cont_combine = Combine keys and values in a sequence of containers, with priority given to the right-most container in the case of duplicates. cont_common_key_chains = Return the key-chains common across all containers. cont_create_if_absent = Add a key to the container with corresponding value, if it is not already present. otherwise, do nothing. cont_contains_sub_structure = Determine whether the current container contains the sub-container structure.</p> Signup and view all the answers

<p>containers = The containers to compare or check. sub_cont = The sub-container to check or find. partial = Whether to also check for partially complete sub-containers. check_shapes = Whether to check array shapes in the sub-structure.</p> Signup and view all the answers

<p>cont_copy = A copy of the container cont_contains_sub_container = Bool cont_diff = Compared containers cont_find_sub_container = The sub-container if it exists</p> Signup and view all the answers

<p>cont_duplicate_array_keychains = Duplicates array keychains within the container. cont_find_sub_structure = Finds a sub-container structure in the current container if it exists. cont_deep_copy = Creates a deep copy (copying all internal tensors) of the container. cont_cutoff_at_depth = Cuts off the container at a specified depth.</p> Signup and view all the answers

<p>cont_identical_array_shapes = Determines whether all of the containers have identical number of arrays and identical array shapes, regardless of their key-chain structures. cont_if_exists = Return the sub-container at the following key if it exists, otherwise None. cont_map = Applies a function to all array values of container. cont_list_stack = Stacks containers of lists together along the specified dimension.</p> Signup and view all the answers

<p>key_chains = The key-chains to apply or not apply the method to. Default is None. to_apply = If True, the method will be applied to key_chains, otherwise key_chains will be skipped. Default is True. build_callable = If true, the leaf nodes which are callables are assumed to be called to build further nested layers. assert_and_assign = If true, then the container being compared with is updated with the value in the container being compared to given that the structures are congruent.</p> Signup and view all the answers

<p>cont_identical_configs = Return a single boolean as to whether the input containers all have identical configs. cont_key_chains_containing = Return key chains containing a specific substring. cont_list_join = Join containers of lists together along the specified dimension. cont_load = Loads a container object from a specified file path.</p> Signup and view all the answers

<p>containers = The containers to check or to perform operations on. check_types = Whether to also check whether the datatypes of the leaf nodes are the same. Default is True. check_shapes = Whether to also check whether the shapes of the leaf nodes are the same. Default is True. partial = Whether to also check for partially complete sub-containers. Default is False.</p> Signup and view all the answers

<p>cont_map_sub_conts = Applies a function to all sub-containers in the container cont_max_depth = Determines the maximum depth of containers cont_multi_map = Applies a function to all array values from a collection of containers</p> Signup and view all the answers

<p>to_apply = Determines whether the method will be applied to key chains or not prune_unapplied = Determines whether to prune key chains for which the function was not applied inplace = Determines whether to apply the mapping inplace, or return a new container include_self = Determines whether to also apply the function to this container</p> Signup and view all the answers

<p>key_chains = None to_apply = True prune_unapplied = False inplace = False</p> Signup and view all the answers

<p>func = Function to apply to each container entry containers = The containers to map key_chains = The key-chains to apply or not apply the method to to_apply = Determines whether the method will be applied to key chains or not</p> Signup and view all the answers

<p>func = Function to apply to each sub-container key_chains = The key-chains to apply or not apply the method to to_apply = Determines whether the method will be applied to key chains or not prune_unapplied = Determines whether to prune key chains for which the function was not applied</p> Signup and view all the answers

<p>cont_map_sub_conts = New container following the function mapped to each sub-container cont_multi_map = New container following the function mapped to each container entry</p> Signup and view all the answers

<p>'green'</p> Signup and view all the answers

<p>'rebuild_child_containers'</p> Signup and view all the answers

<p>'value'</p> Signup and view all the answers

<p>'iteratively'</p> Signup and view all the answers

<p>cont_contains_sub_container</p> Signup and view all the answers

<p>cont_contains_sub_structure</p> Signup and view all the answers

<p>cont_create_if_absent</p> Signup and view all the answers

<p>cont_deep_copy</p> Signup and view all the answers

<p>ignore_key_errors</p> Signup and view all the answers

<p>array_size_limit</p> Signup and view all the answers

<p>The add operator is not defined for a mix of ivy.Container and ivy.Array instances.</p> Signup and view all the answers

<p>Assert whether the current container contains the sub-container structure, otherwise exception raised with the diff printed to screen.</p> Signup and view all the answers

<p>queue_timeout</p> Signup and view all the answers

<p>{'<strong>init</strong>': 'None', '<strong>getitem</strong>': 'Container object at desired query.'}</p> Signup and view all the answers

<p>sets the total array size limit when printing the container</p> Signup and view all the answers

<p>determines whether to rebuild child containers when initializing the object</p> Signup and view all the answers

<p>cont_inplace_update</p> Signup and view all the answers

<p>cont_identical_array_shapes</p> Signup and view all the answers

<p>cont_identical_structure</p> Signup and view all the answers

<p>cont_map</p> Signup and view all the answers

<p>cont_from_disk_as_json</p> Signup and view all the answers

<p>identical key-chains and data types</p> Signup and view all the answers

<p>return an inplace update of out, provided it is not None, by updating with the values in ret</p> Signup and view all the answers

<p>cont_has_key</p> Signup and view all the answers

<p>to_apply</p> Signup and view all the answers

<p>to_apply</p> Signup and view all the answers

<p>Whether to prune key_chains for which the function was not applied</p> Signup and view all the answers

<p>key_chain</p> Signup and view all the answers

<p>Whether to also apply the (possibly in-place) function to this container</p> Signup and view all the answers

<p>It determines whether to rebuild container found in dict_in with these constructor params.</p> Signup and view all the answers

<p>It determines whether to sort the container keys alphabetically or preserve the dict order.</p> Signup and view all the answers

<p><strong>setitem</strong>(query, val)</p> Signup and view all the answers

<p>cont_copy()</p> Signup and view all the answers

<p>The purpose of the 'cont_assert_contains_sub_container' method is to assert that the current container contains the sub-container.</p> Signup and view all the answers

<p>The purpose of the 'cont_assert_contains_sub_structure' method is to assert that the current container contains the sub-container structure.</p> Signup and view all the answers

<p>The purpose of the 'cont_assert_identical' method is to assert whether the input containers are identical.</p> Signup and view all the answers

<p>The purpose of the 'cont_assert_identical_structure' method is to assert whether the input containers have identical structure.</p> Signup and view all the answers

<p>The 'queue_load_sizes' parameter determines the size of the leading dimension of the containers returned by each queue.</p> Signup and view all the answers

<p>The 'cont_diff' function compares keys and values in a sequence of containers, returning the single shared values where they are the same, and new nested sub-dicts with all values where they are different.</p> Signup and view all the answers

<p>The 'container_combine_method' parameter controls the method to use for combining containers arriving from different queues.</p> Signup and view all the answers

<p>The 'cont_copy' method creates a copy of the container.</p> Signup and view all the answers

<p>The 'print_indent' parameter determines the number of spaces to indent each level of the printed container.</p> Signup and view all the answers

<p>The 'cont_contains_sub_structure' method determines whether the current container contains the sub-container structure.</p> Signup and view all the answers

<p>The 'cont_duplicate_array_keychains' method finds and returns the duplicate array key chains in the current container.</p> Signup and view all the answers

<p>The ivy.data_classes.container.base.ContainerBase class inherits from the dict and ABC base classes.</p> Signup and view all the answers

<p>The 'cont_if_exists' method returns the sub-container at the specified key if it exists, otherwise it returns None.</p> Signup and view all the answers

<p>The 'build_callable' parameter in the 'cont_identical_structure' method determines whether the leaf nodes which are callables are assumed to be called to build further nested layers.</p> Signup and view all the answers

<p>The 'to_apply' parameter in the 'cont_identical_structure' method determines whether the method will be applied to the specified key chains or skipped.</p> Signup and view all the answers

<p>The 'partial' parameter in the 'cont_identical_structure' method determines whether to also check for partially complete sub-containers.</p> Signup and view all the answers

<p>The purpose of the 'cont_flatten_key_chain' method is to flatten the key chain of a container object by replacing the nested keys with a specified replacement string.</p> Signup and view all the answers

<p>The 'include_empty' parameter of the 'cont_flatten_key_chains' method determines whether empty containers should be included in the flattened key chains.</p> Signup and view all the answers

<p>The 'format_fn' parameter of the 'cont_format_key_chains' method specifies the formatting function to be applied to the key strings of a container object.</p> Signup and view all the answers

<p>The 'alphabetical_keys' parameter of the 'cont_from_disk_as_hdf5' method determines whether the container keys should be sorted alphabetically or preserve the original dictionary order.</p> Signup and view all the answers

<p>The 'key_chains' parameter determines the key-chains to apply or not apply the method to.</p> Signup and view all the answers

<p>The 'to_apply' parameter determines whether the method will be applied to key_chains or skipped.</p> Signup and view all the answers

<p>The 'prune_unapplied' parameter determines whether to prune key_chains for which the function was not applied.</p> Signup and view all the answers

<p>The 'inplace' parameter determines whether to apply the mapping inplace or return a new container.</p> Signup and view all the answers

<p>The 'include_self' parameter determines whether to also apply the function to the container.</p> Signup and view all the answers

<p>The 'key_chains' parameter determines the key-chains to apply or not apply the method to.</p> Signup and view all the answers