Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
shuyhere committed Aug 4, 2024
1 parent ca116cc commit 3ba66dc
Show file tree
Hide file tree
Showing 17 changed files with 92 additions and 1 deletion.
Binary file added Writerside/images/devtoys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/devtoysmac.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/feishu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/feishuweb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/latexlive.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/matplotlib.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/notion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/notionresearchclub.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/obplugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/obsidian.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/plugins and cavas.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/racking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/remotely save.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/sharenotion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/simpletex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions Writerside/topics/Methods_for_Expriment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Methods for Organizing Your Code and Results.

## Coding

### How to Read Others Code?
When you download a copy of the code project, you should read the **README** file first, in this file, you will get some useful information:
- How to run this code? (We can know the entry of this program.)
- Where is the data we need?

Okay, assuming you have read the **README** file,

xxx

If you have any questions about this code you downloaded, you can check the Github issues page. Maybe someone else has had the same question as you and got the answer there.

### Some Details for Our Coding Process.
Fixed random seed, in the **transformers** library, there is a set_seed function we can use:
```python
from transformers import set_seed
set_seed(2024)
````

Don't put all functions in main.py, please classify them according to their functions.


## Results

wandb

log library
63 changes: 62 additions & 1 deletion Writerside/topics/Tools-and-Applications-to-aid-your-research.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ Also, we sweetly💗 give a overleaf latex template for (AI) paper writing in th
* Color Scheme Designer <https://www.wauu.net/tools/ps/>
![Color Scheme Designer.png](Color Scheme Designer.png){ width="400"}

### Latex
* SimpleTex<https://simpletex.cn/>
![simpletex.png](simpletex.png){ width="400"}
* Latex live<https://www.latexlive.com/home>
![latexlive.png](latexlive.png){ width="400"}

### Create Illustrations

#### Drawing boards
Expand All @@ -84,4 +90,59 @@ Also, we sweetly💗 give a overleaf latex template for (AI) paper writing in th
* Alibaba Iconfont <https://www.iconfont.cn/>
* icons8 <https://icons8.com/>
![icons8.png](icons8.png){ width="400"}
* iconfinder <https://www.iconfinder.com/>
* iconfinder <https://www.iconfinder.com/>

#### Beautiful tables
* matplotlib <https://matplotlib.org/stable/>

If you want to create beautiful illustrations for your data or results, it is quite useful to follow a demo in Matplotlib. Learn about the colors and formats, and keep refining them with them until you develop your own 'library'.
![matplotlib.png](matplotlib.png){ width="400" }


⚠️As a beginner, the fastest way to improve is by consistently emulating others' writing and following their use of beautiful illustrations.

## Create Your Research Club🎵

Most junior researchers often feel overwhelmed when it comes to managing their academic projects and notes. In this section, we introduce some useful tools for that.

### Notebook

#### For easy online collaboration and sharing

* 🌟🌟 Notion <https://www.notion.so/>
![notion.png](notion.png){ width="400" }
Students can register with their edu email to enjoy free (and lifelong) educational plans. learn more here: <https://www.notion.so/product/notion-for-education>
* The best thing about Notion is that you can share your notes publicly without needing to build your own website. (We will provide a guideline on how to create an academic website later.)
Here is an excellent blog powered by notion <https://yaofu.notion.site/An-Initial-Exploration-of-Theoretical-Support-for-Language-Model-Data-Engineering-Part-1-Pretraini-dc480d9bf7ff4659afd8c9fb738086eb>, written by @[Yao Fu](https://yaofu.notion.site/)
* You can use notion to :
* Tracking the progress of your project (you can start with a template <https://www.notion.so/templates>)
![racking.png](racking.png){ width="400" }
* organize all your notes
![notionresearchclub.png](notionresearchclub.png){ width="400" }
* collaboration
![sharenotion.png](sharenotion.png){ width="400" }
* ...
* feishu/lark <https://www.larksuite.com/> zh-cn:<https://www.feishu.cn/>
* ![feishuweb.png](feishuweb.png){ width="400" }
* ![feishu.png](feishu.png){ width="400" }


#### Private and localize writing
The downside of both of the above applications is that they are difficult to synchronize with local files, and if you must have access to local files to feel secure, [obsidian](https://obsidian.md/) is recommended!
* obsidian

![obsidian.png](obsidian.png){ width="400" }

![plugins and cavas.png](plugins and cavas.png){ width="400" }

You can set up the sync by the plugin -- remotely save

![remotely save.png](remotely save.png){ width="400" }

There are many helpful community plugins, download them in `setting-community plugins`
![obplugins.png](obplugins.png){ width="400" }

## Other tools
* Devtoys--little tools for development
![devtoys.png](devtoys.png){ width="400" }
![devtoysmac.png](devtoysmac.png){ width="400" }

0 comments on commit 3ba66dc

Please sign in to comment.