Difference between revisions of "Week 2"
(6 intermediate revisions by the same user not shown) | |||
Line 24: | Line 24: | ||
#* docs, | #* docs, | ||
#* code, | #* code, | ||
− | #* ''[data]'' if you have a ''small dataset'' to demo, | + | #* ''[data]'' if you have a ''small dataset'' to run demo, |
#* ''[figs]'' if you have ''illustrations'' in read.me. | #* ''[figs]'' if you have ''illustrations'' in read.me. | ||
# Put the link to your repository in the group table [https://github.com/intsystems/m1p/tree/main-2025 Spring 2025]. | # Put the link to your repository in the group table [https://github.com/intsystems/m1p/tree/main-2025 Spring 2025]. | ||
Line 67: | Line 67: | ||
#* the authors' contribution. | #* the authors' contribution. | ||
# Add to LinkReview the references to data sources, code repositories, and libraries. | # Add to LinkReview the references to data sources, code repositories, and libraries. | ||
+ | |||
+ | ===Tips for the bibliography collection=== | ||
+ | # Read and collect various sources, but mind [[Step 1#Select this kind of papers|what you cite]]. | ||
+ | # ArXiv is not a peer-reviewed source of information. Look for publications of these papers in peer-reviewed scientific journals. Be careful if the ArXiv paper does not appear in a peer-reviewed journal after one or two years. This paper might be non-verified since the other journals rejected it. | ||
+ | # Wikipedia is not a source of information but contains many useful references. | ||
== B: Beginner's-talk == | == B: Beginner's-talk == | ||
Line 78: | Line 83: | ||
# [[Week_2#Land_your_project|Land your project]]. | # [[Week_2#Land_your_project|Land your project]]. | ||
# Put the links to your project [https://github.com/intsystems/m1p/tree/main-2025 in the group table]. | # Put the links to your project [https://github.com/intsystems/m1p/tree/main-2025 in the group table]. | ||
− | # Prepare the letter '''A''' | + | # Prepare the letter '''A''': |
− | # Put it to '''read.me'''. | + | ## discuss it with your consultant after reading (Step 1) |
+ | ## [[Step 1#Abstract|Abstract]] | ||
+ | ## [[Step 1#Highlights|Highlights]] | ||
+ | ## [[Step 1#Keywords|Keywords]] | ||
+ | ## [[Step 1#Select this kind of papers|Papers]] | ||
+ | # Put it to your .tex. | ||
+ | # Write the '''read.me''' file. | ||
# Read the literature. Put the references to your .bib file, and prepare the letter '''L'''. | # Read the literature. Put the references to your .bib file, and prepare the letter '''L'''. | ||
# Prepare the letter '''B''', the beginner's talk. | # Prepare the letter '''B''', the beginner's talk. | ||
Line 93: | Line 104: | ||
#[http://www.ega-math.narod.ru/Quant/ABS.htm Как написать математическую статью по-английски]. А.Б. Сосинский | #[http://www.ega-math.narod.ru/Quant/ABS.htm Как написать математическую статью по-английски]. А.Б. Сосинский | ||
# [https://orfogrammka.ru/%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA/%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA_%D0%B8%D0%B7%D0%B4%D0%B0%D1%82%D0%B5%D0%BB%D1%8F_%D0%B8_%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B0_%D0%BC%D0%B8%D0%BB%D1%8C%D1%87%D0%B8%D0%BD_%D1%87%D0%B5%D0%BB%D1%8C%D1%86%D0%BE%D0%B2%D0%B0/ Справочник издателя и автора]. А.Э. Мильчин, Л.К. Чельцова | # [https://orfogrammka.ru/%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA/%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA_%D0%B8%D0%B7%D0%B4%D0%B0%D1%82%D0%B5%D0%BB%D1%8F_%D0%B8_%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B0_%D0%BC%D0%B8%D0%BB%D1%8C%D1%87%D0%B8%D0%BD_%D1%87%D0%B5%D0%BB%D1%8C%D1%86%D0%BE%D0%B2%D0%B0/ Справочник издателя и автора]. А.Э. Мильчин, Л.К. Чельцова | ||
+ | |||
+ | ==Teacher's plan== | ||
+ | # Fill out the [https://forms.gle/1qNwWp7DxAM4W6Sg7 questionnaire] (discuss the previous and this one) | ||
+ | # Discuss the umbrella terminology | ||
+ | # Discuss the homework | ||
+ | #* Show the examples of the abstracts | ||
+ | # Discuss the homework section | ||
+ | |||
+ | <!-- ==Archive== | ||
+ | [https://github.com/intsystems/ProjectTemplate old project template is excessive> | ||
+ | --> | ||
+ | ==Steps to check the homework== | ||
+ | # After the [[Course schedule#Consultations|deadline]] | ||
+ | # Run through the [https://github.com/intsystems/m1p/tree/main-2025?tab=readme-ov-file#results table records] | ||
+ | # Check if the links open in one click to the material | ||
+ | #* for the papers there must be .pdf, .tex, and .bib files | ||
+ | # Check the ''Title, Abstract, and Keywords'' in the paper pdf and put the Letter '''A''' | ||
+ | #* or A0 if not | ||
+ | # Check the file ''LinkReview'' and put the letter '''L''' | ||
+ | #* put L0 if not | ||
+ | # Check the quality of the Abstract and usefulness of LinkReview and if needed | ||
+ | #* put comments in the [https://docs.google.com/spreadsheets/d/1k6YFGp_0zwUNeQQZxoNbYdPjIn7iISkXqMRn1Ktc4t8/edit?usp=sharing Table] |
Latest revision as of 14:02, 5 March 2025
The goal of this week is to land our project and write your main message.
Contents
A: Abstract
- Discuss with your consultant the project goals and understand the problem statement.
- Write a draft of your abstract, see the examples. The abstract shall not exceed 600 characters. It may contain:
- wide-range field of the investigated problem,
- narrow problem to focus on,
- features and conditions of the problem,
- the novelty,
- application to illustrate with.
Land your project
- Find in the organization github.com/intsystems
- the existing repository of your project or
- create it with the title Project-N using the project short title, see previous examples.
- Create the folder structure:
- docs,
- code,
- [data] if you have a small dataset to run demo,
- [figs] if you have illustrations in read.me.
- Put the link to your repository in the group table Spring 2025.
- Fill out the readme.md file in the GitHub project. Use this example as a template.
Tips for your healthy repository
Clone the master and upload your contributions. See a short guide to GitHub.
- Update first, Commit after (Pull first, Push after)
- Your own work only, no external archives
- No big files (put link to external datasets)
- No temporary nor dummy files
Tell the difference between branch and fork.
Read the Manual on how to create a repository for educational projects.
If a large collective project continues, create a personal folder in the project repository. Title it Surname2018Title.
L: Literature
We use the LinkReview draft format to share our evanescent ephemeral ideas and impressions we have during the literature reading.
- Collect the list of references including:
- state-of-the-art reviews, tutorials,
- fundamental solutions to the problem,
- the basic algorithm to solve your problem,
- alternative algorithms,
- [changes in the research directions],
- data sets and experiments,
- the papers that use these data sets
- applications of the results,
- names of researchers, who solve this problem,
- their students and teams,
- those, who refer to their works.
- Balance the list of new and well-known works.
- Keep up-to-date the list of keywords to search.
- Continuously fulfill your LinkReview.
- Plan Introduction. Collect
- keywords as the basic termini; those who bring good search results are useful,
- what the paper devoted to,
- the investigated problem,
- the central idea,
- literature review,
- the authors' contribution.
- Add to LinkReview the references to data sources, code repositories, and libraries.
Tips for the bibliography collection
- Read and collect various sources, but mind what you cite.
- ArXiv is not a peer-reviewed source of information. Look for publications of these papers in peer-reviewed scientific journals. Be careful if the ArXiv paper does not appear in a peer-reviewed journal after one or two years. This paper might be non-verified since the other journals rejected it.
- Wikipedia is not a source of information but contains many useful references.
B: Beginner's-talk
Short 45-second introductory talk. Plan of the talk:
- The project goal. What is the motivation and the goal to reach?
- The main idea. What is the message?
- The expected result. What is your delivery, your impact, novelty?
There is no time to show a slide or draw a plot on the blackboard. Do rehearse your talk before the mirror. Week 3 starts with your talk.
Homework
- Land your project.
- Put the links to your project in the group table.
- Prepare the letter A:
- discuss it with your consultant after reading (Step 1)
- Abstract
- Highlights
- Keywords
- Papers
- Put it to your .tex.
- Write the read.me file.
- Read the literature. Put the references to your .bib file, and prepare the letter L.
- Prepare the letter B, the beginner's talk.
References
- List of academic databases and search engines
- How to Read a Paper, by S. Keshav, 2016
- Выполнение исследовательских проектов в коммерческой организации: методические рекомендации
Write or translate?
The rule is simple: write in the language you think in.
- Read with pleasure (Ru) Советы эпизодическому переводчику. С.С. Кутателадзе
- Как написать математическую статью по-английски. А.Б. Сосинский
- Справочник издателя и автора. А.Э. Мильчин, Л.К. Чельцова
Teacher's plan
- Fill out the questionnaire (discuss the previous and this one)
- Discuss the umbrella terminology
- Discuss the homework
- Show the examples of the abstracts
- Discuss the homework section
Steps to check the homework
- After the deadline
- Run through the table records
- Check if the links open in one click to the material
- for the papers there must be .pdf, .tex, and .bib files
- Check the Title, Abstract, and Keywords in the paper pdf and put the Letter A
- or A0 if not
- Check the file LinkReview and put the letter L
- put L0 if not
- Check the quality of the Abstract and usefulness of LinkReview and if needed
- put comments in the Table