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.

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

Add persistent id to front end #385

Merged
merged 5 commits into from
Feb 17, 2023

Conversation

JosephMarinier
Copy link
Contributor

@JosephMarinier JosephMarinier commented Jan 20, 2023

Resolve #377

Description:

Screen.Recording.2023-01-20.at.4.47.52.PM.mov
  • Show persistent id on hover in utterance table, utterance details, and similar utterances.
    • Only when the user has defined a persistent_id column (different that Azimuth's default row_idx), otherwise the tooltip is the same as before.
Screen.Recording.2023-01-20.at.4.48.15.PM.mov

Checklist:

You should check all boxes before the PR is ready. If a box does not apply, check it to acknowledge it.

  • ISSUE NUMBER. You linked the issue number (Ex: Resolve #XXX).
  • PRE-COMMIT. You ran pre-commit on all commits, or else, you
    ran pre-commit run --all-files at the end.
  • USER CHANGES. The changes are added to CHANGELOG.md and the documentation, if they impact
    our users.
  • DEV CHANGES.
    • Update the documentation if this PR changes how to develop/launch on the app.
    • Update the README files and our wiki for any big design decisions, if relevant.
    • Add unit tests, docstrings, typing and comments for complex sections.

@JosephMarinier JosephMarinier self-assigned this Jan 20, 2023
Base automatically changed from joseph/add-persistent-id-to-utterances to main January 23, 2023 21:42
@JosephMarinier JosephMarinier force-pushed the joseph/add-persistent-id-to-front-end branch from 488b45d to ed87456 Compare January 30, 2023 21:57
using a new `BaseUtterance` class to avoid duplication of field definitions.
so for example we see `...001`, `...002`, `...003` (and infer the remaining digits from the page number) instead of `100...`, `100...`, `100...`.
in utterance table, utterance details, and similar utterances.
@JosephMarinier JosephMarinier force-pushed the joseph/add-persistent-id-to-front-end branch from ed87456 to 63f2255 Compare February 14, 2023 18:39
@JosephMarinier JosephMarinier marked this pull request as ready for review February 14, 2023 18:43
Copy link
Contributor

@gabegma gabegma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea for the back end! LGTM for that part.

Copy link
Contributor

@nandhinibsn nandhinibsn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes looks good to me. It would be very much helpful if you could give me an example of what other columns could be in the "persistent_id" from the config. Secondly, where does azimuth evaluates the column idx?. If you could point me out the code, it would be even more helpful to understand.

@JosephMarinier
Copy link
Contributor Author

JosephMarinier commented Feb 15, 2023

@nandhinibsn

What other columns could be in the "persistent_id"?

The persistent_id is configured by the user if the dataset has such a column. More detail in the documentation here.

Where does Azimuth evaluate the column idx?

I'm not sure I understand. What do you mean by "evaluate"?

Copy link
Contributor

@gabegma gabegma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@nandhinibsn
Copy link
Contributor

@nandhinibsn

What other columns could be in the "persistent_id"?

The persistent_id is configured by the user if the dataset has such a column. More detail in the documentation here.

Where does Azimuth evaluate the column idx?

I'm not sure I understand. What do you mean by "evaluate"?

Okay, thank you! My question was if there is any logic to creating an index for each utterance from Azimuth.

@JosephMarinier
Copy link
Contributor Author

@nandhinibsn

My question was if there is any logic to creating an index for each utterance from Azimuth.

Ah yes, as we say in this tooltip, it is an "id created by Azimuth". It is assigned sequentially here:

dataset_split = dataset_split.map(
lambda u, i: {DatasetColumn.row_idx: i}, with_indices=True
)

Copy link
Collaborator

@christyler3030 christyler3030 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Frontend code looks good to me. As discussed, I would still be interested in design input for the UX of persistent ids but we can merge now and improve later.

@JosephMarinier JosephMarinier merged commit 27d8bff into main Feb 17, 2023
@JosephMarinier JosephMarinier deleted the joseph/add-persistent-id-to-front-end branch February 17, 2023 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Show persistent id in front end
4 participants