Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The cache_mode description in DFP docs is incorrect #1696

Closed
ylnhari opened this issue May 10, 2024 · 2 comments · Fixed by #1707
Closed

The cache_mode description in DFP docs is incorrect #1696

ylnhari opened this issue May 10, 2024 · 2 comments · Fixed by #1707

Comments

@ylnhari
Copy link

ylnhari commented May 10, 2024

Morpheus/examples/digital_fingerprinting/production/morpheus/dfp/modules/dfp_rolling_window.py

Line 51 in 26c95e1

- cache_mode (str): The user ID to use if the user ID is not found; Example: 'batch'; Default: 'batch'

This comment seems to confuse the actual use of the config setting.
@efajardo-nv
Copy link
Contributor

Thanks @ylnhari. Yes, that needs to be fixed.

@efajardo-nv efajardo-nv changed the title need clarification in the Docstring The cache_mode description in DFP docs is incorrect May 14, 2024
@efajardo-nv
Copy link
Contributor

Use the corrected descriptions in #1634 if cache_mode support is being added to stage implementation of DFP Rolling Window.

@efajardo-nv efajardo-nv mentioned this issue May 16, 2024
Merged
rapids-bot bot pushed a commit that referenced this issue May 29, 2024
@efajardo-nv
Fix description for cache_mode option of DFP Rolling Window module (#…
e136ab2 
…1707)

- Fix description for `cache_mode` option of DFP Rolling Window module. It was using description for `fallback_username` in multiple places.

Closes #1696

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md).
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Eli Fajardo (https://github.com/efajardo-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #1707
@github-project-automation github-project-automation bot moved this from Todo to Done in Morpheus Boards May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Morpheus Boards
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix description for cache_mode option of DFP Rolling Window module efajardo-nv/Morpheus
2 participants
@ylnhari @efajardo-nv