Difference between revisions of "Week 2"

From m1p.org
Jump to: navigation, search
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 (please not exaggerate),
+
## features and conditions of the problem,
# application to illustrate with (put the results here later).
+
## the novelty,
 +
## application to illustrate with.
  
 
== Land your project ==
 
== Land your project ==
# Discuss with your consultant the project goals and understand the problem statement.
+
# 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''' or using the project short title, [https://github.com/Intelligent-Systems-Phystech see previous examples].
+
## the existing repository of your project or  
#* Put the link to your repository to the organization table using [https://github.com/intsystems/.github/blob/main/profile/repository_structure_rtfm.md#repository-for-educational-project Manual].
+
## create it with the title '''Project-N''' using the project short title, [https://github.com/Intelligent-Systems-Phystech see previous examples].
#* Put the link to your repository [https://github.com/intsystems/m1p in the Group table],.  
 
 
# Create the folder structure:
 
# Create the folder structure:
 
#* docs,
 
#* docs,
Line 26: Line 26:
 
#* data,
 
#* data,
 
#* [figs].
 
#* [figs].
# Put the direct link to the paper [https://github.com/intsystems/m1p in the Group table], so everyone can access it.
+
# Put the link to your repository in the group table [https://github.com/intsystems/m1p/tree/main-2025 Spring 2025].
# Rename article.tex to Surname2020Title.tex
+
# 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.
# Check that both .tex and .pdf files of your paper are downloaded.
+
 
# 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 to your healthy repository===
+
===Tips for your healthy repository===
* GitHub: clone the '''master''' and upload your contributions to it if you are working with your own code only [https://github.com/Strijov/Strijov2018-1AutomationOfResearch/raw/master/GitHubSimplest.pdf See a short guide to  GitHub].
+
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)
+
* ''Update first'', Commit after (Pull first, Push after)
# '''Your own work only''', no external publications
+
* ''Your own work only'', no external archives
# '''No big files''' (put link to external datasets)
+
* ''No big files'' (put link to external datasets)
# '''No temporary''' nor dummy files
+
* ''No temporary'' nor dummy files
Tell the difference [https://stackoverflow.com/questions/5009600/difference-between-fork-and-branch-on-github between '''branch''' and '''fork''']
+
 
 +
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.
  
# If a big 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 Surname2018Title.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].
#* Tip. Copy the link as the URL of the Download button of the PDF file that is in the repository.
+
#* Copy the link as the URL of the Download button of the PDF file that is in the repository.
# Create a draft document of the literature review in the LinkReview format and link it [https://github.com/intsystems/m1p in the Group table].
 
# Tip. Add references to data sources, code, and libraries in LinkReview in addition to the literature.
 
<!--# Tip. Create a group chat.-->
 
  
 +
# 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 fill your LinkReview.
+
# 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 brigs good search results are useful,
+
#* 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].
  
<!-- * [[Media:CommResrarchProtocol.pdf|Методические рекомендации выполнения исследовательских проектов в коммерческой фирме]].-->
+
==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.

A: Abstract

  1. Discuss with your consultant the project goals and understand the problem statement.
  2. Write a draft of your abstract, see the examples. The abstract shall not exceed 600 characters. It may contain:
    1. wide-range field of the investigated problem,
    2. narrow problem to focus on,
    3. features and conditions of the problem,
    4. the novelty,
    5. application to illustrate with.

Land your project

  1. Find in the organization github.com/intsystems
    1. the existing repository of your project or
    2. create it with the title Project-N using the project short title, see previous examples.
  2. Create the folder structure:
    • docs,
    • code,
    • data,
    • [figs].
  3. Put the link to your repository in the group table Spring 2025.
  4. 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.
  1. 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.

  1. Collect the list of references including:
    1. state-of-the-art reviews, tutorials,
    2. fundamental solutions to the problem,
    3. the basic algorithm to solve your problem,
    4. alternative algorithms,
    5. [changes in the research directions],
    6. data sets and experiments,
    7. the papers that use these data sets
    8. applications of the results,
    9. names of researchers, who solve this problem,
    10. their students and teams,
    11. those, who refer to their works.
  2. Balance the list of new and well-known works.
  3. Keep up-to-date the list of keywords to search.
  4. Continuously fulfill your LinkReview.
  5. 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:

  1. The project goal. What is the motivation, the goal to reach?
  2. The main idea. What is the message?
  3. 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

  1. Land your project.
  2. Put the links to your project in the group table.
  3. Prepare the letter A, discuss it with your consultant.
  4. Put it to read.me file.
  5. Read the literature. Put the references to the file, and prepare the letter L.
  6. Prepare the letter B, the beginner's talk.
  1. Create a draft document of the literature review in the LinkReview format and link it in the Group table.

Resources

2024

Old version

  1. Watch the video or video'21 and slides.

References