STARBORN commited on
Commit
60d5d17
Β·
verified Β·
1 Parent(s): 1c0c1eb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -4
README.md CHANGED
@@ -1,15 +1,51 @@
 
1
  title: AICELS
2
  emoji: πŸ”₯
3
  colorFrom: yellow
4
  colorTo: indigo
5
  sdk: gradio
6
- sdk_version: 6.1.0
7
  app_file: app.py
8
  pinned: false
9
  license: mit
10
- short_description: AI Code Evaluation and Learning support First release
11
- This version does not work property at all, but the version on Colab works just fine, we are testing it and so far so good
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
  ---
14
 
15
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
1
+ ---
2
  title: AICELS
3
  emoji: πŸ”₯
4
  colorFrom: yellow
5
  colorTo: indigo
6
  sdk: gradio
7
+ sdk_version: 5.0.0
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
+ short_description: AI Code Evaluation and Learning System - Correctness First
12
+ ---
13
+
14
+ # πŸŽ“ AICELS: AI-Powered Code Evaluation and Learning System
15
+
16
+ **Correctness First, Quality Second**
17
+
18
+ AICELS evaluates Python code in two phases:
19
+ 1. **Priority 0 - Correctness**: Does your code run without errors?
20
+ 2. **Quality Assessment**: How well does it follow best practices?
21
+
22
+ ## Features
23
+
24
+ - βœ… Syntax and runtime error detection
25
+ - πŸ“Š PEP 8 compliance checking
26
+ - πŸ“ Documentation quality assessment
27
+ - 🎯 Naming convention validation
28
+ - πŸ“š Personalized learning paths
29
+ - πŸ† Quality grading (A/B/C/D)
30
+
31
+ ## How to Use
32
+
33
+ 1. Paste your Python code in the input box
34
+ 2. Click "Evaluate Code"
35
+ 3. Review your correctness status and quality grade
36
+ 4. Follow the personalized learning path to improve
37
+
38
+ ## Philosophy
39
+
40
+ Unlike traditional code quality tools, AICELS prioritizes functional correctness before style.
41
+ No amount of beautiful formatting can fix code that doesn't work!
42
+
43
+ ## Development
44
+
45
+ Developed collaboratively by Paola Bertoldi (Ronin Institute, W3C AI Knowledge Representation Community Group) with Claude (Anthropic).
46
+
47
+ Currently in testing phase. Colab version working well, HF deployment being refined.
48
 
49
  ---
50
 
51
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference