Skip to content

Commit

Permalink
Minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@alex-snd
alex-snd committed Oct 24, 2022
1 parent 577cf86 commit 66d76e5
Showing 1 changed file with 16 additions and 21 deletions.
37 changes: 16 additions & 21 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,53 +9,48 @@ hide:
<h1 align="center"><img src="https://github.com/alex-snd/TRecover/blob/assets/preview_animation_white.gif?raw=true" alt="Preview Animation"/></h1>
<div align="center">
<h2 align="center">Welcome to Text Recovery Project 👋 </h2>
<h3 align="center">A python library for decentralized training of a Transformer neural network across the Internet to solve the <a href="https://en.wikipedia.org/wiki/Running_key_cipher">Running Key Cipher</a>, widely known in the field of cryptography.</h3>
<h3 align="center">A python library for distributed training of a Transformer neural network across the Internet to solve the <a href="https://en.wikipedia.org/wiki/Running_key_cipher">Running Key Cipher</a>, widely known in the field of Cryptography.</h3>
<a href="https://huggingface.co/spaces/alex-snd/TRecover">
<img src="https://img.shields.io/badge/demo-%F0%9F%A4%97%20Hugging%20Face-blue?color=%2348466D" alt="Hugging Face demo"/>
</a>
<a href="https://colab.research.google.com/github/alex-snd/TRecover/blob/master/notebooks/TRecover-train-alone.ipynb">
<img src="https://img.shields.io/badge/open%20in-Colab-blue?color=%2348466D" alt="Open%20In%20Colab"/>
<img class="off-glb" src="https://img.shields.io/badge/demo-%F0%9F%A4%97%20Hugging%20Face-blue?color=%2348466D" alt="Hugging Face demo"/>
</a>
<a href="https://wandb.ai/snd/TRecover?workspace=user-snd">
<img src="https://img.shields.io/badge/visualize%20in-W&B-blue?color=%2348466D" alt="Visualize%20in%20W&B"/>
<img class="off-glb" src="https://img.shields.io/badge/visualize%20in-W&B-blue?color=%2348466D" alt="Visualize%20in%20W&B"/>
</a>
<a href="https://alex-snd.github.io/TRecover">
<img src="https://img.shields.io/badge/docs-MkDocs-blue.svg?color=%2348466D" alt="MkDocs link"/>
<img class="off-glb" src="https://img.shields.io/badge/docs-MkDocs-blue.svg?color=%2348466D" alt="MkDocs link"/>
</a>
<img src="https://img.shields.io/badge/python-v3.8.5-blue.svg?color=%2348466D" alt="Python version"/>
<img class="off-glb" src="https://img.shields.io/badge/python-v3.8.5-blue.svg?color=%2348466D" alt="Python version"/>
<a href="https://badge.fury.io/py/trecover">
<img src="https://img.shields.io/pypi/v/trecover?color=%2348466D" alt="PyPI version"/>
<img class="off-glb" src="https://img.shields.io/pypi/v/trecover?color=%2348466D" alt="PyPI version"/>
</a>
<img src="https://static.pepy.tech/personalized-badge/trecover?period=total&units=international_system&left_color=grey&right_color=%2348466D&left_text=pypi downloads" alt="PyPi Downloads"/>
<img class="off-glb" src="https://static.pepy.tech/personalized-badge/trecover?period=total&units=international_system&left_color=grey&right_color=%2348466D&left_text=pypi downloads" alt="PyPi Downloads"/>
<a href="https://github.com/alex-snd/TRecover/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg?color=%2348466D" alt="License Apache 2.0"/>
<img class="off-glb" src="https://img.shields.io/badge/license-Apache%202.0-blue.svg?color=%2348466D" alt="License Apache 2.0"/>
</a>
</div>
<br>

<h3 align="justify">
The main goal of the project is to study the possibility of using Transformer neural network to “read” meaningful text
in columns that can be compiled for a <a href="https://en.wikipedia.org/wiki/Running_key_cipher">Running Key Cipher</a>.
in columns that can be compiled for a Running Key Cipher.
You can read more about the problem <a href="https://alex-snd.github.io/TRecover/objective/task_definition">here</a>.
The second goal is to train a fairly large Transformer model in a distributed manner with the help of volunteers
all over the Internet 🌎.
<br><br>
In addition, rather fun 😅 goal is to train a large enough model so that it can handle the case described
The second goal is to train a fairly large model in a distributed manner with the help of volunteers
from around the globe 🌎.
<p>In addition, rather fun 😅 goal is to train a large enough model so that it can handle the case described
below.<br>
Let there be an original sentence:
</p>
</h3>

!!! attention ""

<h3>Hello, my name is ***Zendaya*** Maree Stoermer Coleman but you can just call me ***Zendaya***.</h3>
<font size="4">Hello, my name is ***Zendaya*** Maree Stoermer Coleman but you can just call me ***Zendaya***.</font>

<h3 align="justify">
The columns for this sentence will be compiled in such a way that the last seven contain from ten to thirteen
letters of the English alphabet, and all the others from two to five. Thus, the last seven characters will be much
harder to "read" compared to the rest. However, we can guess from the meaning of the sentence that this is the
name <b><i>Zendaya</i></b>.
<p>In other words, the goal is also to train a model that can understand and correctly “read” the last word.</p>
</h3>

!!! attention ""

<h3>In other words, the goal is also to train a model that can understand and correctly “read” the last word.</h3>

0 comments on commit 66d76e5

Please sign in to comment.