Stop the _adapt_batch() from changing the batch in-place

[adityasuthar]

Pull Request

Description

The _adapt_batch() method changes the batch in place. This is bad practice. We are updating the method so that it returns a new batch without changing the old one.

Fixes #210

How Has This Been Tested?

I tested by running the python -m pytest tests command.

• Yes

If your changes affect data processing, have you plotted any changes? i.e. have you done a quick sanity check?

• Yes

Checklist:

• My code follows OCF's coding style guidelines
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• I have checked my code and corrected any misspellings

[dfulu]

Hi @adityasuthar, thanks for doing this. I think this won't fully cover the issue. The batch object is a nested dictionary (max depth of 2) so the line you have in to copy it only creates a shallow copy, and the deeper part of the dict can is still changed.

The problem is probably best shown with an example:

# A sample dict
batch_dict = dict(
    a = [1,2,3],
    b = dict(
        b1 = [3,4,5],
        b2 = [6,7,8],
    )
)

# The line to make a new copy of the dict
new_batch_dict = {key: value.copy() for key, value in batch_dict.items()}

# We modify the new dict
new_batch_dict["a"][0] = 0
new_batch_dict["b"]["b1"][0] = 0

# But the nested part of the old dict is still changed
print(batch_dict)
>>> {'a': [1, 2, 3], 'b': {'b1': [0, 4, 5], 'b2': [6, 7, 8]}}

[adityasuthar]

Hi @dfulu,

Thanks for reviewing the code and pointing out the issue with the shallow copy. I have updated the approach to handle the nested dictionary structure in batch using deepcopy.

To correctly copy both the first-level and nested structures, I updated the approach to:

new_batch_dict = {key: copy.deepcopy(value) for key, value in batch_dict.items()}

This ensures all nested elements are fully copied, preventing unwanted modifications.

Example with Fix Applied:

batch_dict = {
    "a": [1, 2, 3],
    "b": {
        "b1": [3, 4, 5], 
        "b2": [6, 7, 8],
    }
}

new_batch_dict = {key: copy.deepcopy(value) for key, value in batch_dict.items()}

# Modify new dict
new_batch_dict["a"][0] = 0
new_batch_dict["b"]["b1"][0] = 0

print(batch_dict)
>>> {'a': [1, 2, 3], 'b': {'b1': [3, 4, 5], 'b2': [6, 7, 8]}}  # Original batch remains unchanged

print(new_batch_dict)
>>> {'a': [0, 2, 3], 'b': {'b1': [0, 4, 5], 'b2': [6, 7, 8]}}  # Only new batch is modified

[adityasuthar]

Hi @dfulu, I have fixed the conflicts that came due to #302
Can you review it? I have made changes as suggested by you

[dfulu]

Hi @adityasuthar, thanks for the work. Looks good!