Skip to content

Commit

Permalink
Merge branch 'update' of https://github.com/DeanHazineh/DFlat into up…
Browse files Browse the repository at this point in the history
…date
  • Loading branch information
DeanHazineh committed Apr 11, 2024
2 parents 6d696a0 + 98331cf commit f0cc950
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
![PyTorch](https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Pytest Workflow](https://github.com/DeanHazineh/DFlat-pytorch/actions/workflows/pytest.yml/badge.svg?branch=dflat_v2.0.0)](https://github.com/DeanHazineh/DFlat-pytorch/actions/workflows/pytest.yml)
![Version](https://img.shields.io/badge/version-2.0.0-blue)
![Version](https://img.shields.io/badge/version-3.0.0-blue)

`D-Flat` is an auto-differentiable design framework for flat optics, specially geared to the design of dielectric metasurfaces for imaging and sensing tasks. This package was first introduced in a 2022 manuscript available at <a href="https://arxiv.org/abs/2207.14780" target="_blank">arxiv</a>. It was later published alongside our paper, <a href="https://deanhazineh.github.io/publications/Multi_Image_Synthesis/MIS_Home.html" target="_blank"> Polarization Multi-Image Synthesis with Birefringent Metasurfaces</a>, in the proceedings of the 2023 IEEE International Conference of Computational Photography (ICCP). It was rewritten in 2024 with Version 2.0.

Expand All @@ -23,12 +23,13 @@ D-Flat provides users with:

By treating optical layers in the same fashion as standard, differentiable neural layers, deep learning pipelines can be built to simultaneously optimize optical hardware and ML computational back-ends for the next generation of computational imaging devices.

## Version Notes (v2.0.0)

- This repository is the home for the new and maintained version of DFlat. It replaces DFlat-Tensorflow.
- Note that this package is no longer a direct port of pytorch-tensorflow but is a complete rewrite (re-)released in February 2024.
- The structure of the software is completely revamped and the algorithms used--in particular for field propagation--are not the same as before. The original pytorch version (now deprecated) is archived and kept as a branch.
- (Coming soon) Accessibility via downloading from the PyPI index.
## Version Notes (v3.0.0)
Updated on April 11, 2024 from V2.0.0
- v3 You can now donwload this package from the PyPi Index!
- v3 Datasets and pre-trained models are now downloaded when called insetad of during install. Models are now initialized by their name instead of by paths to config files.
- v2 This repository is the home for the new and maintained version of DFlat. It replaces DFlat-Tensorflow.
- v2 Note that this package is no longer a direct port of pytorch-tensorflow but is a complete rewrite (re-)released in February 2024.
- v2 The structure of the software is completely revamped and the algorithms used--in particular for field propagation--are not the same as before. The original pytorch version (now deprecated) is archived and kept as a branch.

## Installation

Expand Down

0 comments on commit f0cc950

Please sign in to comment.