Difference between revisions of "Week 2"
| m | |||
| Line 9: | Line 9: | ||
| == A: Abstract ==   | == A: Abstract ==   | ||
| − | Write a ''draft'' of your abstract, [https://github.com/vadim-vic/pub/raw/main/m1p/m1p_lect2.pdf  see the examples]. The abstract shall not exceed 600 characters. It may contain: | + | # Discuss with your consultant the project goals and understand the problem statement. | 
| − | # wide-range field of the investigated problem, | + | # Write a ''draft'' of your abstract, [https://github.com/vadim-vic/pub/raw/main/m1p/m1p_lect2.pdf  see the examples]. The abstract shall not exceed 600 characters. It may contain: | 
| − | # narrow problem to focus on, | + | ## wide-range field of the investigated problem, | 
| − | # features and conditions of the problem, | + | ## narrow problem to focus on, | 
| − | # the novelty  | + | ## features and conditions of the problem, | 
| − | # application to illustrate with  | + | ## the novelty, | 
| + | ## application to illustrate with. | ||
| == Land your project == | == Land your project == | ||
| − | + | # Find in the organization [https://github.com/intsystems github.com/intsystems]   | |
| − | # Find in the organization [https://github.com/intsystems github.com/intsystems] the repository of your project or create it with the title '''Project-N'''  | + | ## the existing repository of your project or   | 
| − | + | ## create it with the title '''Project-N''' using the project short title, [https://github.com/Intelligent-Systems-Phystech see previous examples]. | |
| − | |||
| # Create the folder structure: | # Create the folder structure: | ||
| #* docs, | #* docs, | ||
| Line 26: | Line 26: | ||
| #* data, | #* data, | ||
| #* [figs]. | #* [figs]. | ||
| − | # Put the  | + | # Put the link to your repository in the group table [https://github.com/intsystems/m1p/tree/main-2025 Spring 2025]. | 
| − | + | # Fill out the '''readme.md''' file in the GitHub project. Use [https://github.com/Intelligent-Systems-Phystech/2021-Project-74 this example] as a template. | |
| − | + | ||
| − | # Fill the '''readme.md''' file in the GitHub project. Use [https://github.com/Intelligent-Systems-Phystech/2021-Project-74 this example] as a template. | + | |
| − | ===Tips  | + | ===Tips for your healthy repository=== | 
| − | + | Clone the ''master'' and upload your contributions to it if you are working with your own code only [ 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 [https://stackoverflow.com/questions/5009600/difference-between-fork-and-branch-on-github between '''branch | + | |
| + | Tell the difference [https://stackoverflow.com/questions/5009600/difference-between-fork-and-branch-on-github between '''branch'' and '''fork''] | ||
| + | |||
| + | Read the [https://github.com/intsystems/.github/blob/main/profile/repository_structure_rtfm.md#repository-for-educational-project Manual] on how to create a repository for educational projects. | ||
| + | |||
| + | If a large collective project continues, then create a personal folder in the project repository, title in the Surname2018Title format. Place the file with the ''article template'' in a personal folder. The name is in the Surname2025Title.tex format. | ||
| − | |||
| − | |||
| #* Write a link to the PDF file with the text of the article [https://github.com/intsystems/m1p in the Group table]. | #* Write a link to the PDF file with the text of the article [https://github.com/intsystems/m1p in the Group table]. | ||
| − | #*  | + | #* Copy the link as the URL of the Download button of the PDF file that is in the repository. | 
| − | |||
| − | |||
| − | |||
| + | # Add references to data sources, code, and libraries in LinkReview. | ||
| == L: Literature ==   | == L: Literature ==   | ||
| We use the [https://docs.google.com/document/d/1K7bIzU33MSfeUvg3WITRZX0pe3sibbtH62aw42wxsEI/edit?usp=sharing LinkReview] draft format to share our evanescent ephemeral ideas and impressions we have during the literature reading.    | We use the [https://docs.google.com/document/d/1K7bIzU33MSfeUvg3WITRZX0pe3sibbtH62aw42wxsEI/edit?usp=sharing LinkReview] draft format to share our evanescent ephemeral ideas and impressions we have during the literature reading.    | ||
| Line 62: | Line 63: | ||
| # Balance the list of new and well-known works. | # Balance the list of new and well-known works. | ||
| # Keep up-to-date the list of keywords to search. | # Keep up-to-date the list of keywords to search. | ||
| − | # Continuously  | + | # Continuously fulfill your LinkReview. | 
| # Plan Introduction (see the next todo list), namely collect | # Plan Introduction (see the next todo list), namely collect | ||
| − | #* keywords as the basic termini; those who  | + | #* keywords as the basic termini; those who bring good search results are useful, | 
| #* what the paper devoted to, | #* what the paper devoted to, | ||
| #* the investigated problem, | #* the investigated problem, | ||
| Line 81: | Line 82: | ||
| # [[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''', discuss it with consultant. | + | # Prepare the '''letter A''', discuss it with your consultant. | 
| # Put it to '''read.me''' file. | # Put it to '''read.me''' file. | ||
| # Read the literature. Put the references to the file, and prepare the '''letter L'''. | # Read the literature. Put the references to the file, and prepare the '''letter L'''. | ||
| # Prepare the '''letter B''', the beginner's talk. | # Prepare the '''letter B''', the beginner's talk. | ||
| + | # Create a draft document of the literature review in the LinkReview format and link it [https://github.com/intsystems/m1p in the Group table]. | ||
| == Resources == | == Resources == | ||
| ===2024=== | ===2024=== | ||
| Line 104: | Line 106: | ||
| # Watch the [https://www.youtube.com/watch?v=FP3DfKxyUnk&list=PLk4h7dmY2eYE2Lp2ScMRSGDxLIbJr4vJ8&index=5 video] or [https://youtu.be/V-5EQUsPGX4?list=PLk4h7dmY2eYF2DWWi6LoByk_ZaoHWh3na&t=2034 video'21] and [http://www.machinelearning.ru/wiki/images/1/1e/M1p2022lect2 slides]. | # Watch the [https://www.youtube.com/watch?v=FP3DfKxyUnk&list=PLk4h7dmY2eYE2Lp2ScMRSGDxLIbJr4vJ8&index=5 video] or [https://youtu.be/V-5EQUsPGX4?list=PLk4h7dmY2eYF2DWWi6LoByk_ZaoHWh3na&t=2034 video'21] and [http://www.machinelearning.ru/wiki/images/1/1e/M1p2022lect2 slides]. | ||
| − | + | ==References== | |
| + | * [http://www.machinelearning.ru/wiki/images/1/1a/CommResrarchProtocol.pdf Выполнение исследовательских проектов] в коммерческой организации: методические рекомендации. | ||
| * [https://web.stanford.edu/class/ee384m/Handouts/HowtoReadPaper.pdf How to Read a Paper, 2016, S. Keshav] | * [https://web.stanford.edu/class/ee384m/Handouts/HowtoReadPaper.pdf How to Read a Paper, 2016, S. Keshav] | ||
Revision as of 20:06, 22 February 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,
- [figs].
 
- 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 to it if you are working with your own code only [ 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, then create a personal folder in the project repository, title in the Surname2018Title format. Place the file with the article template in a personal folder. The name is in the Surname2025Title.tex format.
- Write a link to the PDF file with the text of the article in the Group table.
- Copy the link as the URL of the Download button of the PDF file that is in the repository.
 
- Add references to data sources, code, and libraries in LinkReview.
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 (see the next todo list), namely 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.
 
B: Beginner's-talk
Short 45-second introductory talk. Plan of the talk:
- The project goal. What is the motivation, 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. Instead, rehearse the report. 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.
- Put it to read.me file.
- Read the literature. Put the references to the file, and prepare the letter L.
- Prepare the letter B, the beginner's talk.
- Create a draft document of the literature review in the LinkReview format and link it in the Group table.
Resources
2024
Old version
- Slides for week 2 – Slides 2022.
- [Video for week 2].
- Bibliographic database[es
- The Collection of Computer Science Bibliographies
- List of academic databases and search engines in Wikipedia
- Refer to BibTeX in Wikipedia
- An introduction updated after a peer-review.
 
- Examples of rewiev-and-planning drafts LinkReview one, two.
- Демотиватор про Карлсона
References
- Выполнение исследовательских проектов в коммерческой организации: методические рекомендации.
- How to Read a Paper, 2016, S. Keshav