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

Boxylmer #49

Open
wants to merge 24 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
3c9567f
Update Flowchart-Designer.md
timurbazhirov Dec 22, 2022
6a71804
Update Materials-Designer.md
timurbazhirov Feb 11, 2023
96e01f3
fix: file name in URL
timurbazhirov Feb 11, 2023
6ccf5f7
Create branch, lay out plan for today and tomorrow
Boxylmer Sep 12, 2023
53a8104
Implemented a good start for data loader + testing
Boxylmer Sep 12, 2023
8d1e0ee
exported requirements.txt
Boxylmer Sep 12, 2023
f16b325
File renaming
Boxylmer Sep 12, 2023
4ec80dc
cache featurized model inputs once calculated, sketched AbstractBandG…
Boxylmer Sep 12, 2023
9595fdf
two models implemented, performance is sub par. Need to test various …
Boxylmer Sep 13, 2023
202fc39
writeup of current results, plan set for wednesday
Boxylmer Sep 13, 2023
047c95e
Optional override for model hyperparameters
Boxylmer Sep 13, 2023
c0c56f1
more planning, needing to step away to TA
Boxylmer Sep 13, 2023
c92c575
Lots of output changes and diagnostics moved around; started editing …
Boxylmer Sep 13, 2023
5ff7a97
Made new truncated flag on dataloader to eventually test reduced feat…
Boxylmer Sep 13, 2023
a1ac699
Much more parity improvements achieved. Many more descriptors added.
Boxylmer Sep 14, 2023
f8803ac
Documented the two band gap model PoCs
Boxylmer Sep 15, 2023
17b1bdf
docs written, dataloader abstraction increased (previous implementati…
Boxylmer Sep 16, 2023
4caecc5
One quick comment on writeup
Boxylmer Sep 16, 2023
3ca62e5
fixed typos and finished some errant doc TODOs
Boxylmer Sep 16, 2023
d331c8f
Whoops, forgot to explain how to add the API key
Boxylmer Sep 16, 2023
5beeb15
last edit
Boxylmer Sep 16, 2023
6cb0440
Added jupyter notebook
Boxylmer Sep 18, 2023
69e7e50
update gitignore
Boxylmer Sep 18, 2023
4fd6e3f
reset gitignore
Boxylmer Sep 18, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
api_key.txt
boxylmer/tests/__pycache__/*
boxylmer/tests/test_output/*
boxylmer/MaterialPropertyPredictor/__pycache__/*

8 changes: 7 additions & 1 deletion Flowchart-Designer.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,10 @@ We leave exact timing to the candidate. Must fit Within 5 days total.

# Examples

To view examples or discuss this task more in details, please [contact us](README.md).
We recommend reviewing the following:

- Introduction to Flowcharts: https://www.geeksforgeeks.org/an-introduction-to-flowcharts/
- An example convergence workflow: https://docs.mat3ra.com/models/auxiliary-concepts/reciprocal-space/convergence/
- ReactFlow library examples: https://reactflow.dev/docs/examples/overview/ and https://pro.reactflow.dev/pro-examples

To discuss this task more in details, please [contact us](README.md).
4 changes: 2 additions & 2 deletions Materials-Designer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

# Overview

Create a skeleton IDE (integrated development environment) for materials design. Close to Adobe Dreamweaver (or any other IDE) - when you can change html-markup and simultaneously see the result in another tab. We edit material in XYZ format and view result in 3D.
Create a skeleton IDE (integrated development environment) for materials design, where one can change text and simultaneously see the visual result in another tab. We edit material in XYZ format and view result in 3D.

Front-end developers: use Meteor and React.js and minimalistic UX/UI.
Front-end developers: use React.js and minimalistic UX/UI.

Pure UI/UX designers: create high fidelity mockups. 

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Each file represents an assignment similar to what one would get when hired.
| Front-End / UX | [Materials Designer](Materials-Designer.md) | ReactJS / UX Design, ThreeJS |
| Front-End / UX | [Flowchart Designer](Flowchart-Designer.md) | ReactJS / UX Design, DAG |
| Back-End / Ops | [Parallel Uploader](Parallel-File-Uploader.md) | Python, OOD, Threading, Objectstore |
| CI/CD, DevOps | [End-to-End Tests](End-To-End-Tests.md) | BDD tests, CI/CD workflows, Cypress |
| CI/CD, DevOps | [End-to-End Tests](End-to-End-Tests.md) | BDD tests, CI/CD workflows, Cypress |
| HPC, Cloud Inf | [Cloud HPC Bench.](Cloud-Infrastructure.md) | HPC Cluster, Linpack, Benchmarks |
| HPC, Containers| [Containerized HPC](Containerization-HPC.md) | HPC Cluster, Containers, Benchmarks |

Expand Down
31 changes: 31 additions & 0 deletions boxylmer/ML-Band-Gaps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ML Band Gaps (Materials)

> Ideal candidate: skilled ML data scientist with solid knowledge of materials science.

# Overview

The aim of this task is to create a python package that implements automatic prediction of electronic band gaps for a set of materials based on training data.

# User story

As a user of this software I can predict the value of an electronic band gap after passing training data and structural information about the target material.

# Requirements

- suggest the bandgap values for a set of materials designated by their crystallographic and stoichiometric properties
- the code shall be written in a way that can facilitate easy addition of other characteristics extracted from simulations (forces, pressures, phonon frequencies etc)

# Expectations

- the code shall be able to suggest realistic values for slightly modified geometry sets - eg. trained on Si and Ge it should suggest the value of bandgap for Si49Ge51 to be between those of Si and Ge
- modular and object-oriented implementation
- commit early and often - at least once per 24 hours

# Timeline

We leave exact timing to the candidate. Must fit Within 5 days total.

# Notes

- use a designated github repository for version control
- suggested source of training data: materialsproject.org
Loading