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

Repo updates #83

Merged
merged 14 commits into from
Aug 3, 2023
Merged

Repo updates #83

merged 14 commits into from
Aug 3, 2023

Conversation

AntObi
Copy link
Collaborator

@AntObi AntObi commented Aug 3, 2023

Pull Request Template

  • Added attribute for checking if an Embedding instance is standardised
  • Added method standardise to the Embedding class to standardise the vectors
  • Added examples to main README.md
  • Added visualisations to main README.md
  • Added link to representation folder in README.md
  • Added usage examples of the composition module to the README.md
  • Replaced oliynyk.json with oliynyk.csv to preserve feature labels
  • Updated core.py

Fixes #67

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Test Configuration:

  • Python version: 3.9
  • Operating System: WSL2(Ubuntu)

Reviewers

N/A

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@codecov
Copy link

codecov bot commented Aug 3, 2023

Codecov Report

Merging #83 (fb2e072) into main (13c73d3) will decrease coverage by 0.34%.
Report is 10 commits behind head on main.
The diff coverage is 86.79%.

@@            Coverage Diff             @@
##             main      #83      +/-   ##
==========================================
- Coverage   90.96%   90.62%   -0.34%     
==========================================
  Files           9        9              
  Lines         852      896      +44     
==========================================
+ Hits          775      812      +37     
- Misses         77       84       +7     
Files Changed Coverage Δ
src/elementembeddings/core.py 83.98% <82.92%> (-0.58%) ⬇️
src/elementembeddings/tests/test_core.py 100.00% <100.00%> (ø)

@AntObi AntObi merged commit c57e0c5 into main Aug 3, 2023
10 of 12 checks passed
@AntObi AntObi deleted the repo_updates branch August 3, 2023 18:11
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.

Update repo README
1 participant