Skip to content

Conversation

@Devasy23
Copy link
Contributor

@Devasy23 Devasy23 commented Mar 22, 2024

Pull Request Title

Enhancements and Improvements to Workspace Information Handling

Related Issue

N/A

Description

This pull request introduces several enhancements and improvements to the workspace information handling process. It includes updates to documentation, logger improvements, logging integration into the Streamlit app, and an alternative method for calculating similarity scores.

Type

  • Bug Fix
  • Feature Enhancement
  • Documentation Update
  • Code Refactoring
  • Other (please specify):

Proposed Changes

  • Comprehensive documentation added to the get_score and get_similarity_score files.
  • Updates made to the logger.py file for improved modularity.
  • Logging integrated into the streamlit_app.py file.
  • Feature added to calculate similarity scores without using an API in streamlit_interactive.py.

Screenshots / Code Snippets (if applicable)

image

How to Test

  1. Pull the latest changes from this branch.
  2. Verify that documentation has been updated and is comprehensive.
  3. Ensure the logger.py file functions as expected in different scenarios.
  4. Test logging functionality in the Streamlit app by triggering various events.
  5. Verify the alternative similarity score calculation method in streamlit_interactive.py.

Checklist

  • The code compiles successfully without any errors or warnings
  • The changes have been tested and verified
  • The documentation has been updated (if applicable)
  • The changes follow the project's coding guidelines and best practices
  • The commit messages are descriptive and follow the project's guidelines
  • All tests (if applicable) pass successfully
  • This pull request has been linked to the related issue (if applicable)

Additional Information

These changes aim to improve the maintainability and functionality of the workspace information handling process. Feedback and further suggestions are welcomed.

@Devasy23
Copy link
Contributor Author

@srbhr you can see GPT4 enable code review on this commit here : Devasy23#2

Also, i need to commit after linting it with black and isort

@srbhr
Copy link
Owner

srbhr commented Mar 23, 2024

GPT-4 enabled code review ?

@Devasy23
Copy link
Contributor Author

GPT-4 enabled code review ?

yes, by github app called senior-dev

@srbhr
Copy link
Owner

srbhr commented Mar 25, 2024

@Devasy23 is this PR good to merge?

@Devasy23
Copy link
Contributor Author

Devasy23 commented Mar 25, 2024

@Devasy23 is this PR good to merge?

Yes it's good to merge but for extra surety just check it once.

The major changes are in utils.logger where I modularised the functions and also added docstrings, streamlit_interactive where I added the similarity score without api changes and added coloured rounded view of similarity score in streamlit_app.py

Everything else are formatting changes done by black and isort.

@srbhr
Copy link
Owner

srbhr commented Mar 25, 2024

Okay, so we have black as a formatter. This needs to go in the readme, which needs updating and a separate PR.

@srbhr srbhr merged commit 76062e9 into srbhr:main Mar 25, 2024
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.

2 participants