update tru virtual docs

[piotrm0]

• Added more documentation for VirtualRecord and some other parts of tru_virtual.py to make it clearer how to set various fields and what the defaults are if not set.
• Fixed a bug in dashboard when displaying components that are json base types.
• Updated virtual records example notebook to fix outdated usage.
• Removed artificial delay in virtual record construction and replaced with addition of small timedelta if needed to make Perf span represent non-zero duration which causes some dashboard issues otherwise.

---

	🚀 This PR description was created by Ellipsis for commit 8826a03.

Summary:

This PR enhances the documentation for tru_virtual.py, fixes a dashboard bug related to JSON base types, updates the virtual records example notebook, and optimizes the virtual record construction process.

Key points:

• Enhanced documentation for VirtualRecord and other parts of tru_virtual.py.
• Fixed a bug in the dashboard when displaying components that are JSON base types.
• Updated virtual records example notebook to fix outdated usage.
• Optimized the virtual record construction process by removing an artificial delay and adding a small timedelta if needed to make Perf span represent non-zero duration.

---

Generated with ❤️ by ellipsis.dev

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[ellipsis-dev]

👍 Looks good to me!

• Reviewed the entire pull request up to 6db49cd
• Looked at 187 lines of code in 3 files
• Took 1 minute and 3 seconds to review

More info

• Skipped 1 files when reviewing.
• Skipped posting 1 additional comments because they didn't meet confidence threshold of 50%.

1. trulens_eval/trulens_eval/tru_virtual.py:37:

• Assessed confidence : 0%
• Comment:
  The added documentation and changes in this file are clear and well implemented. Good job on removing the artificial delay and replacing it with a small timedelta addition to ensure non-zero duration.
• Reasoning:
  The PR author has added extensive documentation to the tru_virtual.py file, which is a good practice. The changes in the Evaluations.py file seem to handle the case when the app_component_json is not a dictionary, which is a good error handling practice. The removal of the artificial delay in the VirtualRecord class and its replacement with a small timedelta addition to ensure non-zero duration is a good performance improvement. Overall, the changes seem to be well thought out and correctly implemented.

Workflow ID: wflow_hz4KqULXqOjrPzjf

---

Not what you expected? You can customize the content of the reviews using rules. Learn more here.

[ellipsis-dev]

👍 Looks good to me!

• Performed an incremental review on e2a2baa
• Looked at 41 lines of code in 1 files
• Took 1 minute and 14 seconds to review

More info

• Skipped 0 files when reviewing.
• Skipped posting 1 additional comments because they didn't meet confidence threshold of 50%.

1. trulens_eval/trulens_eval/tru_virtual.py:207:

• Assessed confidence : 33%
• Comment:
  Consider using a constant for the small timedelta value (1 microsecond) that is added to ensure non-zero duration. This would make the code more maintainable and the purpose of this value clearer.

NON_ZERO_DURATION = datetime.timedelta(microseconds=1)
if (subend_time - substart_time).total_seconds() == 0.0:
    subend_time += NON_ZERO_DURATION

• Reasoning:
  The changes in this PR seem to be primarily focused on improving the performance of the VirtualRecord class by removing an artificial delay and adding a small timedelta only when necessary. This is a good change as it can potentially improve the performance of the application. The changes also include improved documentation and a bug fix in the dashboard. The code changes seem to be logically correct and do not appear to introduce any new bugs. However, I would like to suggest a minor improvement.

Workflow ID: wflow_XUFoDuGRyhHMZ0eW

---

Not what you expected? You can customize the content of the reviews using rules. Learn more here.

[ellipsis-dev]

Skipped PR review on 0804bdc because no changed files had a supported extension. If you think this was in error, please contact us and we'll fix it right away.

---

Generated with ❤️ by ellipsis.dev

[ellipsis-dev]

👍 Looks good to me!

• Performed an incremental review on 99c92ff
• Looked at 12 lines of code in 1 files
• Took 41 seconds to review

More info

• Skipped 0 files when reviewing.
• Skipped posting 1 additional comments because they didn't meet confidence threshold of 50%.

1. trulens_eval/trulens_eval/tru_virtual.py:11:

• Assessed confidence : 0%
• Comment:
  Good job on removing the unused 'time' import. This helps to keep the code clean and efficient.
• Reasoning:
  The import of the 'time' module has been removed, but there is no usage of it in the code. This is a good practice to remove unused imports as it can improve the performance of the code and make it cleaner.

Workflow ID: wflow_jPn16bKsoqtt8ZEw

---

Not what you expected? You can customize the content of the reviews using rules. Learn more here.

[ellipsis-dev]

👍 Looks good to me!

• Performed an incremental review on 8826a03
• Looked at 202 lines of code in 3 files
• Took 1 minute and 59 seconds to review

More info

• Skipped 1 files when reviewing.
• Skipped posting 1 additional comments because they didn't meet confidence threshold of 50%.

1. trulens_eval/trulens_eval/tru_virtual.py:140:

• Assessed confidence : 0%
• Comment:
  Great job on enhancing the documentation for VirtualRecord and other parts of tru_virtual.py. This will make the code more understandable and maintainable. Also, good work on optimizing the virtual record construction process by removing an artificial delay and adding a small timedelta if needed to make Perf span represent non-zero duration. This will improve the performance of the virtual record construction process.
• Reasoning:
  The PR author has added more documentation for VirtualRecord and some other parts of tru_virtual.py to make it clearer how to set various fields and what the defaults are if not set. This is a good practice as it makes the code more understandable and maintainable. The author has also fixed a bug in the dashboard when displaying components that are JSON base types. This is a good fix as it prevents potential errors and improves the user experience. The author has updated the virtual records example notebook to fix outdated usage. This is a good update as it ensures that the example notebook is up-to-date and can be used as a reliable reference. The author has removed an artificial delay in virtual record construction and replaced it with the addition of a small timedelta if needed to make Perf span represent non-zero duration which causes some dashboard issues otherwise. This is a good optimization as it improves the performance of the virtual record construction process.

Workflow ID: wflow_tyvzqNUur5PIJFFA

---

Not what you expected? You can customize the content of the reviews using rules. Learn more here.