Skip to content

Commit 5c9591e

Browse files
Rename DeepSynth2 to DeepSynth in README
1 parent 38e6ee1 commit 5c9591e

1 file changed

Lines changed: 14 additions & 16 deletions

File tree

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
![DeepSynth2 Logo](./images/logo.png)
2-
31
--------------------------------------------------------------------------------
4-
[![Tests](https://github.com/SynthesisLab/DeepSynth2/actions/workflows/tests.yaml/badge.svg)](https://github.com/SynthesisLab/DeepSynth2/actions/workflows/tests.yaml)
2+
[![Tests](https://github.com/SynthesisLab/DeepSynth/actions/workflows/tests.yaml/badge.svg)](https://github.com/SynthesisLab/DeepSynth/actions/workflows/tests.yaml)
53

6-
DeepSynth2 is a high-level framework that enables to leverage program synthesis for other domains such as reinforcement learning or system design.
4+
DeepSynth is a high-level framework that enables to leverage program synthesis for other domains such as reinforcement learning or system design.
75

86
<!-- toc -->
97

10-
- [More About DeepSynth2](#more-about-deepsynth2)
8+
- [More About DeepSynth](#more-about-DeepSynth)
119
- [Combining Deep Learning with Theoretical Guarantees](#combining-deep-learning-with-theoretical-guarantees)
1210
- [A Scalable Framework](#a-scalable-framework)
1311
- [Installation](#installation)
1412
- [From Source](#from-source)
15-
- [Install DeepSynth2](#install-deepsynth2)
13+
- [Install DeepSynth](#install-DeepSynth)
1614
- [Documentation](#documentation)
17-
- [Online](https://theomat.github.io/DeepSynth2/)
15+
- [Online](https://theomat.github.io/DeepSynth/)
1816
- [Local](#documentation)
1917
- [Troubleshooting](#troubleshooting)
2018
- [Examples](./examples)
@@ -23,9 +21,9 @@ DeepSynth2 is a high-level framework that enables to leverage program synthesis
2321

2422
<!-- tocstop -->
2523

26-
## More About DeepSynth2
24+
## More About DeepSynth
2725

28-
At a granular level, DeepSynth2 is a library that consists of the following components:
26+
At a granular level, DeepSynth is a library that consists of the following components:
2927

3028
| Component | Description |
3129
| ---- | --- |
@@ -44,7 +42,7 @@ Elaborating Further:
4442

4543
The advantage of "classic" algorithms are their theoretical guarantees.
4644
But many new deep learning based methods have emerged, they provide a tremendous efficiency but lose almost all theoretical guarantees.
47-
DeepSynth2 provides already implemented algorithms that combine both approaches to get the best of both worlds: speed and guarantees!
45+
DeepSynth provides already implemented algorithms that combine both approaches to get the best of both worlds: speed and guarantees!
4846

4947
### A Scalable Framework
5048

@@ -60,9 +58,9 @@ For example, you can split probabilistic grammars into disjoint sub grammars to
6058

6159
If you are installing from source, you will need Python 3.8 or later.
6260

63-
#### Install DeepSynth2
61+
#### Install DeepSynth
6462

65-
DeepSynth2 can be installed from source with `pip`, `conda` or `poetry`.
63+
DeepSynth can be installed from source with `pip`, `conda` or `poetry`.
6664

6765
```bash
6866
pip install .
@@ -78,7 +76,7 @@ See this [open issue of poetry](https://github.com/python-poetry/poetry/issues/6
7876

7977
## Documentation
8078

81-
[Online Documentation](https://theomat.github.io/DeepSynth2/)
79+
[Online Documentation](https://theomat.github.io/DeepSynth/)
8280

8381

8482
You might want to generate html pages of the documentation locally, where usage, contribution guidelines and more can be found.
@@ -105,16 +103,16 @@ There are some known issues:
105103

106104
## The Team
107105

108-
DeepSynth2 is a project initiated by [Nathanaël Fijalkow](https://nathanael-fijalkow.github.io/) and by [Théo Matricon](https://theomat.github.io/).
106+
DeepSynth is a project initiated by [Nathanaël Fijalkow](https://nathanael-fijalkow.github.io/) and by [Théo Matricon](https://theomat.github.io/).
109107
It is based on the [DeepSynth](https://github.com/nathanael-fijalkow/DeepSynth) project of [Nathanaël Fijalkow](https://nathanael-fijalkow.github.io/), [Guillaume Lagarde](https://guillaume-lagarde.github.io/), [Théo Matricon](https://theomat.github.io/), [Kevin Ellis](https://www.cs.cornell.edu/~ellisk/), [Pierre Ohlmann](https://www.irif.fr/~ohlmann/), Akarsh Potta
110108

111109
Former:
112110

113-
- (2023) [Félix Yvonnet](https://github.com/Felix-Yvonnet) did a 2 months internship to work on restarts, a future feature of DeepSynth2.
111+
- (2023) [Félix Yvonnet](https://github.com/Felix-Yvonnet) did a 2 months internship to work on restarts, a future feature of DeepSynth.
114112
- (2023) [Priscilla Tissot](https://fr.linkedin.com/in/priscilla-tissot-9493851b8) did a 7 weeks long internship working on the Carel neural network and trying to improve the performance of our prediction models.
115113
- (2022) [Gaëtan Margueritte](https://github.com/gaetanmargueritte) did a four-month internship. He created the regexp and transduction DSLs, the first tutorial and first drafts of code related to the use of user defined constants.
116114
- (2022) Utkarsh Rajan did a two-month internship. He contributed to the implementation of bucket search and worked on the tower DSL.
117115

118116
## License
119117

120-
DeepSynth2 has a MIT license, as found in the [LICENSE](LICENSE.md) file.
118+
DeepSynth has a MIT license, as found in the [LICENSE](LICENSE.md) file.

0 commit comments

Comments
 (0)